Expire an access token.

Expire an access token before the token's expiration date and revoke access to the system.

Access tokens normally expire within an hour. This operation expires an access token upon request so that the token may no longer be used for future operations.

The Request Body must be a JSON object.
The following parameters are required to expire the access token:

{  
  "endpointUrl": "URL",  
  "clientId": "string",  
  "userPoolId": "string",
  "username": "string",
  "password": "string",
  "session":
  {
    "accessToken": "string",
    "refreshToken": "string",
    "authorization": "string"
  }
}
SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

AccessToken
required
string

Provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Responses
200

Successful operation

401

Unauthorized operation. This occurs when invalid refresh token and user credentials are provided.

502

Bad Gateway. Missing clientId or userPoolId

delete/auth/token
Request samples 
Response samples 
application/json
{
  • "endpointUrl": "https://endpoint.url/v1",
  • "clientId": "12345abc",
  • "userPoolId": "us-east-1_123456789",
  • "username": "username",
  • "password": "",
  • "session": {
    }
}