Skip to content

Commit f619714

Browse files
committedSep 5, 2023
Update OAuth workflow diagram
1 parent 9ac909b commit f619714

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed
 

‎README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ user's email address. Scopes are a vector of either strings or
7575
keywords, and are specific to the website you're authenticating
7676
against.
7777

78-
The next URIs are internal to your application:
78+
The next URIs are internal to your application and may be any URI you
79+
wish that your server can respond to:
7980

8081
* `:launch-uri`
8182
* `:redirect-uri`
@@ -135,9 +136,20 @@ and complete authentication of the user.
135136

136137
The following image is a workflow diagram that describes the OAuth2
137138
authorization process for Ring-OAuth2. It should give you an overview
138-
of how all the different URIs interact.
139-
140-
![OAuth2 Workflow](https://github.com/weavejester/ring-oauth2/raw/master/docs/workflow.png)
139+
of how all the different URIs interact:
140+
141+
```mermaid
142+
sequenceDiagram
143+
Client->>Ring Server: GET :launch-uri
144+
Ring Server-->>Client: redirect to :authorize-uri
145+
Client->>Auth Server: GET :authorize-uri
146+
Auth Server-->>Client: redirect to :redirect-uri
147+
Client->>Ring Server: GET :redirect-uri
148+
Ring Server->>Auth Server: POST :access-token-uri
149+
Auth Server->>Ring Server: returns access token
150+
Ring Server-->>Client: redirect to :landing-uri
151+
Client->>Ring Server: GET :landing-uri
152+
```
141153

142154
## Contributing
143155

‎docs/workflow.png

-12.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)