Resource to manage OAuth 2.0 tokens for an app
Note: To configure refresh tokens for an app, see grant_types and refresh_token.
Lists all refresh tokens for an app
Note: The results are paginated according to the
limitparameter. If there are multiple pages of results, the Link header contains anextlink that you need to use as an opaque value (follow it, don't parse it).
| expand | string An optional parameter to return scope details in the Example: expand=scope |
| after | string Specifies the pagination cursor for the next page of results. Treat this as an opaque value obtained through the next link relationship. See Pagination. Example: after=16275000448691 |
| limit | integer <int32> <= 1000 Default: 200 Specifies the batch size of the results to be returned |
Success
Forbidden
Not Found
Too Many Requests
[- {
- "id": "oar579Mcp7OUsNTlo0g3",
- "status": "ACTIVE",
- "created": "2023-03-09T03:18:06.000Z",
- "lastUpdated": "2023-03-09T03:18:06.000Z",
- "expiresAt": "2023-03-16T03:18:06.000Z",
- "clientId": "0oabskvc6442nkvQO0h7",
- "userId": "00u5t60iloOHN9pBi0h7",
- "scopes": [
- "offline_access",
- "car:drive"
], - "_embedded": {
- "scopes": [
- {
- "id": "scppb56cIl4GvGxy70g3",
- "name": "offline_access",
- "description": "Requests a refresh token by default and is used to obtain more access tokens without re-prompting the user for authentication",
- "_links": {
- "scope": {
- "title": "offline_access"
}
}
}, - {
- "id": "scp142iq2J8IGRUCS0g4",
- "name": "car:drive",
- "displayName": "Drive car",
- "description": "Allows the user to drive a car",
- "_links": {
- "scope": {
- "title": "Drive car"
}
}
}
]
}, - "_links": {
- "revoke": {
- "hints": {
- "allow": [
- "DELETE"
]
}
}, - "client": {
- "title": "Example Client App"
}, - "user": {
- "title": "Saml Jackson"
}, - "authorizationServer": {
- "title": "Example Authorization Server"
}
}
}
]Revokes all OAuth 2.0 refresh tokens for the specified app. Any access tokens issued with these refresh tokens are also revoked, but access tokens issued without a refresh token aren't affected.
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}Retrieves a refresh token for the specified app
Success
Forbidden
Not Found
Too Many Requests
{- "id": "oar579Mcp7OUsNTlo0g3",
- "status": "ACTIVE",
- "created": "2023-03-09T03:18:06.000Z",
- "lastUpdated": "2023-03-09T03:18:06.000Z",
- "expiresAt": "2023-03-16T03:18:06.000Z",
- "clientId": "0oabskvc6442nkvQO0h7",
- "userId": "00u5t60iloOHN9pBi0h7",
- "scopes": [
- "offline_access",
- "car:drive"
], - "_embedded": {
- "scopes": [
- {
- "id": "scppb56cIl4GvGxy70g3",
- "name": "offline_access",
- "description": "Requests a refresh token by default and is used to obtain more access tokens without re-prompting the user for authentication",
- "_links": {
- "scope": {
- "title": "offline_access"
}
}
}, - {
- "id": "scp142iq2J8IGRUCS0g4",
- "name": "car:drive",
- "displayName": "Drive car",
- "description": "Allows the user to drive a car",
- "_links": {
- "scope": {
- "title": "Drive car"
}
}
}
]
}, - "_links": {
- "revoke": {
- "hints": {
- "allow": [
- "DELETE"
]
}
}, - "client": {
- "title": "Example Client App"
}, - "user": {
- "title": "Saml Jackson"
}, - "authorizationServer": {
- "title": "Example Authorization Server"
}
}
}Revokes the specified token for the specified app
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}