Authentication API
Generate access tokens that authorize API calls.
API Inputs
Request Inputs
The token request has one input, a header. It has no query parameters and no body.
Authorization
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | Basic {Base64-encoded username:password} |
| Example | Basic dXNlcm5hbWU6cGFzc3dvcmQ= |
Specifies your credentials, as a Base64-encoded username:password string with the Basic scheme. Required. Encode the username and password as one string, with the colon between them.
Response Fields
These fields are returned by a successful token request.
access_token
| Attribute | Value |
|---|---|
| Type | Response Payload |
| Data Type | string |
| Possible Values | A signed JSON Web Token |
| Example | eyJhbGciOiJ... |
The token to use as a Bearer token in the Authorization header of requests to the other APIs.
expires_in
| Attribute | Value |
|---|---|
| Type | Response Payload |
| Data Type | integer |
| Possible Values | The number of seconds until the token expires |
| Example | 3599 |
The number of seconds until the token expires. After expiry, request a new token.
token_type
| Attribute | Value |
|---|---|
| Type | Response Payload |
| Data Type | string |
| Possible Values | Bearer |
| Example | Bearer |
The token type. The value is always Bearer.
Error Fields
These fields are returned when the request fails.
error_message
| Attribute | Value |
|---|---|
| Type | Response Payload |
| Data Type | string |
| Possible Values | A description of the error |
| Example | Incorrect username or password |
A human-readable description of the error.