Skip to content

Commit 5cec448

Browse files
AndyButlandacoumb
andauthored
Added diagrams for flows. (#33)
* Added diagrams for flows. * Updated readme. * Code order tidy. * OAuth1 flow diagrams --------- Co-authored-by: Adrian Cojocariu <[email protected]>
1 parent 98e2de9 commit 5cec448

14 files changed

+15539
-5
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,40 @@ The branching strategy in this repository follows a "gitflow" model:
266266

267267
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.
268268

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+
![OAuth2 Display of Service Status](./docs/images/oauth2-display-service-status.png)
278+
279+
#### OAuth2 Authorization Flow
280+
281+
This diagram shows the steps and components involved in the authorization flow for the OAuth2 protocol.
282+
283+
![OAuth2 Authorization Flow](./docs/images/oauth2-authorization-flow.png)
284+
285+
#### 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+
![OAuth1 Display of Service Status](./docs/images/oauth1-display-service-status.png)
290+
291+
#### OAuth1 Authorization Flow
292+
293+
This diagram shows the steps and components involved in the authorization flow for the OAuth1 protocol.
294+
295+
![OAuth1 Authorization Flow](./docs/images/oauth1-authorization-flow.png)
296+
297+
#### Calling an Authorized Service
298+
299+
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.
300+
301+
![OAuth2 Authorization Flow](./docs/images/call-authorized-service.png)
302+
269303
### Component Description
270304

271305
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

Comments
 (0)