Account
OAuth Clients List
https://api.linode.com/v4/account/oauth-clients
Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application.
Query Parameters
The page of a collection to return.
The number of items to return per page.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/account/oauth-clients
Response Samples
- 200
- default
{
"data": [
{
"id": "",
"status": "active",
"label": "Test_Client_1",
"redirect_uri": "https://example.org/oauth/callback",
"secret": "<REDACTED>",
"thumbnail_url": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail",
"public": ""
}
],
"page": 1,
"pages": 1,
"results": 1
}Responses
200: A paginated list of OAuth Clients.
The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
The status of this application. active by default.
The name of this application. This will be presented to users when they are asked to grant it access to their Account.
The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.
The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
The URL where this client's thumbnail may be viewed, or null if this client does not have a thumbnail set.
If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the OAuth spec for more details.
The current page.
The total number of pages.
The total number of results.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.
OAuth Client Create
https://api.linode.com/v4/account/oauth-clients
Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities.
Request Body Schema
The name of this application. This will be presented to users when they are asked to grant it access to their Account.
The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.
If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the OAuth spec for more details.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"redirect_uri": "https://example.org/oauth/callback",
"label": "Test_Client_1",
"public": false
}' \
https://api.linode.com/v4/account/oauth-clients
Response Samples
- 200
- default
{
"status": "active",
"id": 1234,
"redirect_uri": "https://example.org/oauth/callback",
"label": "Test_Client_1",
"secret": "<REDACTED>",
"thumbnail_url": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail",
"public": ""
}Responses
200: Client created successfully.
The status of this application. active by default.
The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).
The location a successful log in from https://login.linode.com should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.
The name of this application. This will be presented to users when they are asked to grant it access to their Account.
The OAuth Client secret, used in the OAuth exchange. This is returned as <REDACTED> except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.
The URL where this client's thumbnail may be viewed, or null if this client does not have a thumbnail set.
If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the OAuth spec for more details.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.