Tags:
- Phase›Realized
Custom Gateway API Endpoint
Paths
/password/oauth2/revoke
Revoke access
The token revoke call requires the resource owner to pass the valid client credentails, a valid token and the token type as inputs. The inputs are validated by the authorization server and after successful validation the token is tagged as revoked. If you pass access Token in the request, the corresponding refresh token will also be revoked and vice-versa. The tokens are marked invalid after revocation is successful.
HTTP Basic authentication by passing base64 encoded value of the client id and client secret separated by colon (:).Example: Base64(client_id:client_secret) will be passed as Basic KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
Content type. Value is application/x-www-form-urlencoded
The request has succeeded
error |
invalid_request |
invalid_grant |
unauthorized_client |
unsupported_grant_type |
error |
invalid_client |
server_error
Definitions
{
"properties": {
"status": {
"type": "string",
"description": "The status of the token revocation request.",
"example": "success"
}
}
}
{
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_request",
"unauthorized_client",
"access_denied",
"unsupported_response_type",
"invalid_scope",
"server_error",
"temporarily_unavailable",
"unsupported_token_type"
],
"description": "If the request fails due to a missing, invalid, or mismatching redirection URI, or if the client identifier is missing or invalid, the authorization server SHOULD inform the resource owner of the error and MUST NOT automatically redirect the user-agent to the invalid redirection URI."
},
"error_description": {
"type": "string",
"description": "Human-readable ASCII [USASCII] text providing additional information, used to assist the client developer in understanding the error that occurred"
},
"error_uri": {
"type": "string",
"description": "A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error."
}
},
"required": [
"error"
]
}