Authenticate

POST - /auth-api/v2/authenticate

Authenticates the user with a User Identifier and Secret. Returns an access token that can be attached to the header of any API request to authenticate the user, and a refresh token which can be used to obtain a new access token. See Authentication for more information.

Parameters

userIdentifier (required)

Identifies the API User

userSecret (required)

Authenticates the API User

Returns
{
    "response": {
        "code": "SUCCESS",
        "data": {
            "accessToken": "{access token}",
            "expiresIn": 1458,
            "refreshExpiresIn": 1455,
            "refreshToken": "{refresh token}",
            "tokenType": "Bearer",
            "sessionState": ""
        }
    }
}

accessToken

Token to authenticate all other API requests.

expiresIn

Number of seconds until access token expires

refreshToken

Token for a Refresh Authentication request

refreshExpiresIn

Number of seconds until refresh token expires.

tokenType

Type of access token being returned. Currently, this will always be Bearer

Examples