You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34Lines changed: 34 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -266,6 +266,40 @@ The branching strategy in this repository follows a "gitflow" model:
266
266
267
267
The following details are those useful for those contributing to development of the package, and for anyone interested in the how it has been implemented. For anyone using the package too, and finding the existing configuration options aren't sufficient to specify a particular service, there may be scope to provide a custom implementation for particular components.
268
268
269
+
### Flow Diagrams
270
+
271
+
The following diagrams indicate some of the key authentication and authorization flows supported by the package, along with the components involved.
272
+
273
+
#### OAuth2 Display of Service Status and Authorization Link
274
+
275
+
This diagram shows the steps involved with finding and displaying the status of a service in the backoffice, along with how the authorization URL that the user is presented with to initiate the authorization process is generated.
276
+
277
+

278
+
279
+
#### OAuth2 Authorization Flow
280
+
281
+
This diagram shows the steps and components involved in the authorization flow for the OAuth2 protocol.
#### OAuth1 Display of Service Status and Authorization Link
286
+
287
+
This diagram shows the steps involved with finding and displaying the status of a service in the backoffice, along with how the authorization URL that the user is presented with to initiate the authorization process is generated.
288
+
289
+

290
+
291
+
#### OAuth1 Authorization Flow
292
+
293
+
This diagram shows the steps and components involved in the authorization flow for the OAuth1 protocol.
The following diagram shows the steps and components involved in making a request to an external service. It shows the three methods available: OAuth2, OAuth1 and API key.
Note that there has been a deliberate decision taken in designing the package to use a number of components, each responsible for a small part of the authentication and authorization flow. In this way, there's more scope for an implementor to replace specific parts of the implementation should they need to.
0 commit comments