The Access Token Object

This is an object representing an access token.

Properties

id
number

The numeric ID

access
string

Type of token : public, private (preview token), theme, or release.
branch_id
number

The branch to which the token is associated. Requires the Pipeline App (null otherwise).
name
string

The name of the access token
space_id
number

Numeric ID of a space
token
string

The token
story_ids
number[]

List of story IDs that can be accessed with the access token. Requires the Access Token Scopes App ([] otherwise).
min_cache
number

The minimum of seconds for the CDN cache. Default 0
release_ids
number[]

An array of release IDs associated with an access token.
To associate a release with a token, the release must be set to Restricted. Requires the Releases App ([] otherwise).

Example Object

{
    "api_keys": [
        {
            "id": 650836,
            "access": "public",
            "branch_id": 32198,
            "name": "New",
            "space_id": 123123,
            "token": "13Kft3335iwbBOI333wawtt",
            "story_ids": [
                123,
                1234,
                1321            
             ],
            "min_cache": 60,
            "release_ids": []
        },
        {
            "id": 448948,
            "access": "private",
            "branch_id": null,
            "name": null,
            "space_id": 233027,
            "token": "333LMgPcrM555kSeSL988gtt",
            "story_ids": [],
            "min_cache": 0,
            "release_ids": []
        },
        {
            "id": 66337183532202,
            "access": "release",
            "branch_id": null,
            "name": "my-release-token",
            "space_id": 233027,
            "token": "JyOBLHbIvKGBLMCR7LY2Mwtt",
            "story_ids": [],
            "min_cache": 0,
            "release_ids": [
                12345678901234
             ]
        }
    ]
}