Skip to content

Commit a188a71

Browse files
committed
Update OAuth workflow diagram
1 parent 9ac909b commit a188a71

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

README.md

+25-2
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,32 @@ and complete authentication of the user.
135135

136136
The following image is a workflow diagram that describes the OAuth2
137137
authorization process for Ring-OAuth2. It should give you an overview
138-
of how all the different URIs interact.
138+
of how all the different URIs interact:
139+
140+
```mermaid
141+
sequenceDiagram
142+
Client->>Ring Server: GET :launch-uri
143+
Ring Server-->>Client: redirect to :authorize-uri
144+
Client->>Auth Server: GET :authorize-uri
145+
Auth Server-->>Client: redirect to :redirect-uri
146+
Client->>Ring Server: GET :redirect-uri
147+
Ring Server->>Auth Server: POST :access-token-uri
148+
Auth Server->>Ring Server: returns access token
149+
Ring Server-->>Client: redirect to :landing-uri
150+
Client->>Ring Server: GET :landing-uri
151+
```
152+
153+
The following URIs are set by the authorization server and should be absolute:
154+
155+
- `:authorize-uri`
156+
- `:access-token-uri`
157+
158+
The remaining URIs are set by you, and may be any local URI you deem
159+
appropriate:
139160

140-
![OAuth2 Workflow](https://github.com/weavejester/ring-oauth2/raw/master/docs/workflow.png)
161+
- `:launch-uri`
162+
- `:redirect-uri`
163+
- `:landing-uri`
141164

142165
## Contributing
143166

docs/workflow.png

-12.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)