Skip to main content

Create an access token

POST 

/auth/access_tokens

Creates a new access token object.

Request

Body

required

    api_key_id stringrequired

    API Key for which to create the Access Token.

    expiration stringrequired

    Expiration datetime in ISO 8601 format

    permission_groups string[]required

    Array of ids of Permission Groups on the Access Token.

Responses

200: Successful response

Schema

    data

    object

    token string

    Access token.

    api_key_id stringrequired

    API Key for which to create the Access Token.

    expiration stringrequired

    Expiration datetime in ISO 8601 format

    permission_groups string[]required

    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

Schema

    errors

    object[]

  • 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

Schema

    errors

    object[]

  • 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

Schema

    errors

    object[]

  • 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.

  • ]

Loading...