Request/Refresh an access token.

Use this operation to request an access token to perform other API operations that require authorization.

The authentication response includes an accessToken which is used as the AccessToken request header when performing any authenticated operation.

This operation will also accept the previous authentication response as the request payload to return a refreshed access token. The access token expires after 1 hour and must be refreshed after expiration, using the included refreshToken. The refresh token can be used for up to 30 days to request new access tokens, or until the refresh token is revoked. Once the refresh token expires or is revoked, the user credentials must be provided again to generate a new access token and refresh token.

SecurityBasicAuth and ApiKeyAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body must be a JSON-formatted string.

The following parameters are required to request an access token:

  • clientId
  • username
  • password

The following parameters are required to refresh the access token:

  • accessToken
  • refreshToken
clientId
string

Use in new token request

username
string

Use in new token request

password
string

Use in new token request

object (AuthRequest_session)

Use this to refresh token

Responses
200

Successful operation

400

Bad request

401

Unauthorized operation. This occurs when invalid user credentials are provided.

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