Account
OAuth Client View
https://api.linode.com/v4/account/oauth-clients/{clientId}Returns information about a single OAuth client.
Path Parameters
The OAuth Client ID to look up.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c
Response Samples
- 200
- default
{
"status": "active",
"id": 1234,
"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": ""
}Responses
200: Information about the requested client.
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 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.
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 Update
https://api.linode.com/v4/account/oauth-clients/{clientId}Update information about an OAuth Client on your Account. This can be especially useful to update the redirect_uri of your client in the event that the callback url changed in your application.
Path Parameters
The OAuth Client ID to look up.
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.
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 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.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X PUT -d '{
"redirect_uri": "https://example.org/oauth/callback",
"label": "Test_Client_1"
}
}' \
https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c
Response Samples
- 200
- default
{
"id": 1234,
"redirect_uri": "https://example.org/oauth/callback",
"label": "Test_Client_1",
"status": "active",
"secret": "<REDACTED>",
"thumbnail_url": "https://api.linode.com/v4/account/clients/2737bf16b39ab5d7b4a1/thumbnail",
"public": ""
}Responses
200: Client updated successfully.
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 status of this application. active by default.
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.
OAuth Client Delete
https://api.linode.com/v4/account/oauth-clients/{clientId}Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by https://login.linode.com, and all tokens issued to this client will be invalidated (meaning that if your application was using a token, it will no longer work).
Path Parameters
The OAuth Client ID to look up.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
-X DELETE \
https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c
Response Samples
- 200
- default
{}Responses
200: Client deleted successfully.
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.