Access Tokens V1

Access Token operations

Create an access token

Creates a new access token object.

SecuritybasicAuth or bearerAuth
Request
Request Body schema: application/json
required
api_key_id
required
string

API Key for which to create the Access Token.

expiration
required
string

Expiration datetime in ISO 8601 format

permission_groups
required
Array of strings

Array of ids of Permission Groups on the Access Token.

Responses
200

Successful response

Response Schema: application/json
object (Access Token)
token
string

Access token.

api_key_id
required
string

API Key for which to create the Access Token.

expiration
required
string

Expiration datetime in ISO 8601 format

permission_groups
required
Array of strings

Array of ids of Permission Groups on the Access Token.

record_type
string

Record type.

created_at
string

Timestamp of resource creation.

updated_at
string

Timestamp of last resource update.

401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

404

Resource not found

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

post/auth/access_tokens
Request samples
application/json
{
  • "api_key_id": "f30e7596-586e-44e1-ae7d-53db10f144d3",
  • "expiration": "2018-02-09T00:00:00.000000Z",
  • "permission_groups": [
    • "string"
    ]
}
Response samples
application/json
{
  • "data": {
    • "token": "XXXXXXXXXXXXX",
    • "api_key_id": "f30e7596-586e-44e1-ae7d-53db10f144d3",
    • "expiration": "2018-02-09T00:00:00.000000Z",
    • "permission_groups": [
      • "string"
      ],
    • "record_type": "access_token",
    • "created_at": "2018-02-08T18:49:22.998023Z",
    • "updated_at": "2018-02-08T18:49:22.998023Z"
    }
}