Mirror
/
app-MAIL-temp
mirror of https://github.com/simple-login/app.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve oauth doc

This commit is contained in:
Son NK 2021-04-01 18:10:27 +02:00
parent 085dec069b
commit 38730bdecd
1 changed files with 5 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/oauth.md
View File

@ -4,21 +4,18 @@ SL currently supports code and implicit flow.
#### Code flow #### Code flow
To trigger the code flow locally, you can go to the following url after running `python server.py`: To trigger the code flow locally, you can go to the [following url](http://localhost:7777/oauth/authorize?client_id=client-id&state=123456&response_type=code&redirect_uri=http%3A%2F%2Flocalhost%3A7000%2Fcallback&state=random_string) after running `python server.py`:
```
http://localhost:7777/oauth/authorize?client_id=client-id&state=123456&response_type=code&redirect_uri=http%3A%2F%2Flocalhost%3A7000%2Fcallback&state=random_string
```
You should see there the authorization page where user is asked for permission to share their data. Once user approves, user is redirected to this url with an `authorization code`: `http://localhost:7000/callback?state=123456&code=the_code` You should see the authorization page where user is asked for permission to share their data. Once user approves, user is redirected to this url with an `authorization code`: `http://localhost:7000/callback?state=123456&code=the_code`
Next, exchange the code to get the token with `{code}` replaced by the code obtained in previous step. The `http` tool used here is https://httpie.org Next, exchange the code to get the token with `{code}` replaced by the code obtained in previous step. The `http` tool used here is [httpie](https://httpie.org)
``` ```
http -f -a client-id:client-secret http://localhost:7777/oauth/token grant_type=authorization_code code={code} http -f -a client-id:client-secret http://localhost:7777/oauth/token grant_type=authorization_code code={code}
``` ```
This should return an `access token` that allows to get user info via the following command. Again, `http` tool is used. This should return an `access token` that allows to get user info via the following command. Again, `http` is used.
``` ```
http http://localhost:7777/oauth/user_info 'Authorization:Bearer {token}' http http://localhost:7777/oauth/user_info 'Authorization:Bearer {token}'
@ -27,11 +24,7 @@ http http://localhost:7777/oauth/user_info 'Authorization:Bearer {token}'
#### Implicit flow #### Implicit flow
Similar to code flow, except for the the `access token` which we we get back with the redirection. Similar to code flow, except for the the `access token` which we we get back with the redirection.
For implicit flow, the url is For implicit flow, you can use [this url](http://localhost:7777/oauth/authorize?client_id=client-id&state=123456&response_type=token&redirect_uri=http%3A%2F%2Flocalhost%3A7000%2Fcallback&state=random_string)
```
http://localhost:7777/oauth/authorize?client_id=client-id&state=123456&response_type=token&redirect_uri=http%3A%2F%2Flocalhost%3A7000%2Fcallback&state=random_string
```
#### OpenID and OAuth2 response_type & scope #### OpenID and OAuth2 response_type & scope