Skip to main content

GetPartnerTokensResponse

tokens object[]nullable

Array of tokens

  • Array [
  • idstringnullable

    Token ID

    Example: 9fkgh6
    namestringnullable

    Token name

    createdAtstring<date-time>required

    Token creation date and time

    Example: 2022-12-21T10:01:11.123
    expiresIninteger<int32>required

    Token validity period in seconds

    Example: 3600
    expiresAtstring<date-time>required

    Token expiry date and time

    Example: 2022-12-21T10:01:11.123
    isRevokedbooleanrequired

    If the value is true, the token has been revoked

    isExpiredbooleanrequired

    If the value is true, the token has expired

    isValidbooleanrequired

    If the value is true, the token is valid

    The token is not valid if it is either revoked or expired. Only valid tokens can be used to access the API.

    scopestringrequired

    Scopes, delimited with space

    Possible values: non-empty

    Example: partner:create user:create
    lastUsedAtstring<date-time>nullable

    Date and time when the token was last used

    Example: 2023-04-21T10:01:11.123
    revokedAtstring<date-time>nullable

    Date and time when the token was revoked

    Example: 2023-04-21T10:01:11.123
  • ]
  • pagination objectnullable

    Pagination info

    pageNumberinteger<int32>

    Returned page number

    Example: 1
    previousPageReferencestringnullable

    Reference to get the previous page

    nextPageReferencestringnullable

    Reference to get the next page

    previousPagestring<uri>nullable

    URL of the previous page

    nextPagestring<uri>nullable

    URL of the next page

    pageSizeinteger<int32>

    Number of items per page

    Example: 25
    pagesCountinteger<int32>nullable

    Total number of pages

    Example: 5
    totalCountinteger<int32>

    Total number of items

    Example: 125
    GetPartnerTokensResponse
    {
    "tokens": [
    {
    "id": "9fkgh6",
    "name": "string",
    "createdAt": "2022-12-21T10:01:11.123",
    "expiresIn": 3600,
    "expiresAt": "2022-12-21T10:01:11.123",
    "isRevoked": true,
    "isExpired": true,
    "isValid": true,
    "scope": "partner:create user:create",
    "lastUsedAt": "2023-04-21T10:01:11.123",
    "revokedAt": "2023-04-21T10:01:11.123"
    }
    ],
    "pagination": {
    "pageNumber": 1,
    "previousPageReference": "string",
    "nextPageReference": "string",
    "previousPage": "string",
    "nextPage": "string",
    "pageSize": 25,
    "pagesCount": 5,
    "totalCount": 125
    }
    }