Skip to content

Commit f068e68

Browse files
author
hzoppetti
committed
applied changes requested by wsmith
1 parent db2da72 commit f068e68

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

openapi.yaml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ info:
4949
## OAuth
5050
If all you need is a Personal Access Token, feel free to skip ahead to the next section.
5151

52-
For more help on OAuth see our guide on [How to Create an OAuth App with teh Linode Python API Library](https://www.linode.com/docs/platform/api/how-to-create-an-oauth-app-with-the-linode-python-api-library/#oauth-2-authentication-exchange).
52+
For more help on OAuth see our guide on [How to Create an OAuth App with the Linode Python API Library](https://www.linode.com/docs/platform/api/how-to-create-an-oauth-app-with-the-linode-python-api-library/#oauth-2-authentication-exchange).
5353

54-
Before you begin, you need to [Create an OAuth Client](https://developers.linode.com/api/v4/account-oauth-clients/#post).
54+
Before you begin, you need to creat an OAuth client. You can do this [with the API](https://developers.linode.com/api/v4/account-oauth-clients/#post) or [via the Cloud Manager](https://cloud.linode.com/profile/clients).
5555

5656
- For this you will pass a `label` and a `redirect_uri`.
5757
- The return from this endpoint will give you a `client_id` and a `secret`.
@@ -67,8 +67,10 @@ info:
6767
| 3. The user logs into the authorization server with their username and password. | 3. The user logs into the authorization server with their username and password. |
6868
| 4. The authorization server redirects the user to the specificed redirect URL with a temporary authorization `code` (exchange code) in the URL. | 4. The authorization server redirects the user back to your applaction with an OAuth token in the URL hash. This is temporary and expires in 2 hours without a `refresh_token`. |
6969
| 5. The application issues a POST request (*see below*) to the authentication server with the exchange code, `client_id`, and the client application's `client_secret`. In return, the server returns an OAuth token and `refresh_token`. | |
70-
| 6. The authentication server responds to the client application with a new OAuth `access_token`. `access_token` is set to expire in 2 hours if not refreshed. | |
71-
| 7. The refresh token can be used to get a new OAuth `access_token` for another 2 hours by contacting the authentication server again with the `client_id`, `client_secret`, and `refresh_token`. | |
70+
| 6. The authentication server responds to the client application with a new OAuth `access_token`. `access_token` is set to expire in 2 hours. | |
71+
| 7. The `refresh_token` can be used to get a new OAuth `access_token`, good for another 2 hours, and a new `refresh_token`, which you can use to extend the session again by this same method, by contacting the authentication server again with the `client_id`, `client_secret`, and `refresh_token`. | |
72+
73+
The following is more information for the private workflow expanding on step 5 and beyond.
7274

7375
Once the User has logged into Linode and you have received an exchange code,
7476
you will need to trade that exchange code for an Authorization token. You
@@ -81,11 +83,11 @@ info:
8183
Make this request as `application/x-www-form-urlencoded` or as
8284
`multipart/form-data` and include the following parameters in the POST body:
8385

84-
| PARAMETER | DESCRIPTION | FIND OR UPDATE THIS INFORMATION |
85-
|-----------|-------------|---------------------------------|
86-
| client_id | Your app's client ID. | [List your OAuth Clients](https://developers.linode.com/api/v4/account-oauth-clients). |
87-
| client_secret | Your app's client secret. | [View your OAuth Client](https://developers.linode.com/api/v4/account-oauth-clients-client-id). [Reset Your OAuth Client Secret](https://developers.linode.com/api/v4/account-oauth-clients-client-id-reset-secret/#post). |
88-
| code | The code you just received from the redirect | [View your OAuth Client](https://developers.linode.com/api/v4/account-oauth-clients-client-id). [Reset Your OAuth Client Secret](https://developers.linode.com/api/v4/account-oauth-clients-client-id-reset-secret/#post). |
86+
| PARAMETER | DESCRIPTION |
87+
|-----------|-------------|
88+
| client_id | Your app's client ID. |
89+
| client_secret | Your app's client secret. |
90+
| code | The code you just received from the redirect |
8991

9092
You'll get a reponse like this:
9193

0 commit comments

Comments
 (0)