Skip to content

Commit 9e10135

Browse files
authored
Merge branch 'master' into release-4.14.0
2 parents 471b7ac + 10a3ba5 commit 9e10135

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

openapi.yaml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
openapi: 3.0.1
22
info:
33
version: 4.14.0
4+
45
title: Linode API
56
description: |
67
# Introduction
@@ -47,7 +48,7 @@ info:
4748
| **HTTP Authorization Scheme** | bearer |
4849

4950
## OAuth
50-
If you only need to access the Linode API for personal uses,
51+
If you only need to access the Linode API for personal use,
5152
we recommend that you create a [personal access token](#personal-access-token).
5253
If you're designing an application that can authenticate with an arbitrary Linode user, then
5354
you should use the OAuth 2.0 workflows presented in this section.
@@ -66,7 +67,7 @@ info:
6667
### OAuth Workflow
6768

6869
The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used
69-
to authenticate a User before an application can start making API calls on the User's behalf.
70+
to authenticate a user before an application can start making API calls on the user's behalf.
7071

7172
Notes:
7273

@@ -76,19 +77,19 @@ info:
7677

7778
| PRIVATE WORKFLOW | PUBLIC WORKFLOW |
7879
|------------------|------------------|
79-
| 1. The User visits the application's website and is directed to login with Linode. | 1. The User visits the application's website and is directed to login with Linode. |
80+
| 1. The user visits the application's website and is directed to login with Linode. | 1. The user visits the application's website and is directed to login with Linode. |
8081
| 2. Your application then redirects the user to Linode's [login server](https://login.linode.com) with the client application's `client_id` and requested OAuth `scope`, which should appear in the URL of the login page. | 2. Your application then redirects the user to Linode's [login server](https://login.linode.com) with the client application's `client_id` and requested OAuth `scope`, which should appear in the URL of the login page. |
8182
| 3. The user logs into the login server with their username and password. | 3. The user logs into the login server with their username and password. |
82-
| 4. The login server redirects the user to the specificed redirect URL with a temporary authorization `code` (exchange code) in the URL. | 4. The login server redirects the user back to your application with an OAuth `access_token` embedded in the redirect URL's hash. This is temporary and expires in 2 hours. No `refresh_token` is issued. Therefore, once the `access_token` expires, a new one will need to be issued by having the user log in again. |
83+
| 4. The login server redirects the user to the specificed redirect URL with a temporary authorization `code` (exchange code) in the URL. | 4. The login server redirects the user back to your application with an OAuth `access_token` embedded in the redirect URL's hash. This is temporary and expires in two hours. No `refresh_token` is issued. Therefore, once the `access_token` expires, a new one will need to be issued by having the user log in again. |
8384
| 5. The application issues a POST request (*see below*) to the login server with the exchange code, `client_id`, and the client application's `client_secret`. | |
84-
| 6. The login server responds to the client application with a new OAuth `access_token` and `refresh_token`. The `access_token` is set to expire in 2 hours. | |
85-
| 7. The `refresh_token` can be used by contacting the login server with the `client_id`, `client_secret`, and `refresh_token` to get a new OAuth `access_token` and `refresh_token`. The new `access_token` is good for another 2 hours, and the new `refresh_token`, can be used to extend the session again by this same method. | |
85+
| 6. The login server responds to the client application with a new OAuth `access_token` and `refresh_token`. The `access_token` is set to expire in two hours. | |
86+
| 7. The `refresh_token` can be used by contacting the login server with the `client_id`, `client_secret`, and `refresh_token` to get a new OAuth `access_token` and `refresh_token`. The new `access_token` is good for another two hours, and the new `refresh_token`, can be used to extend the session again by this same method. | |
8687

8788
### OAuth Private Workflow - Additional Details
8889

8990
The following information expands on steps 5 through 7 of the private workflow:
9091

91-
Once the User has logged into Linode and you have received an exchange code,
92+
Once the user has logged into Linode and you have received an exchange code,
9293
you will need to trade that exchange code for an `access_token` and `refresh_token`. You
9394
do this by making an HTTP POST request to the following address:
9495

0 commit comments

Comments
 (0)