Skip to main content
Docs

The Backend APIKey object

The Backend APIKey object holds information about an API key.

Properties

  • Name
    claims
    Type
    null | Record<string, any>
    Description

    Custom claims associated with the API key.

  • Name
    createdAt
    Type
    number
    Description

    The date when the API key was created.

  • Name
    createdBy
    Type
    null | string
    Description

    The user ID for the user creating the API key.

  • Name
    description
    Type
    null | string
    Description

    An optional description for the API key.

  • Name
    expiration
    Type
    null | number
    Description

    The expiration date and time of the API key. null if the API key never expires.

  • Name
    expired
    Type
    boolean
    Description

    A boolean indicating whether the API key has expired.

  • Name
    id
    Type
    string
    Description

    A unique ID for the API key.

  • Name
    lastUsedAt
    Type
    null | number
    Description

    The date and time when the API key was last used to authenticate a request.

  • Name
    name
    Type
    string
    Description

    The API key's name.

  • Name
    revocationReason
    Type
    null | string
    Description

    The reason for revoking the API key, if it has been revoked.

  • Name
    revoked
    Type
    boolean
    Description

    A boolean indicating whether the API key has been revoked.

  • Name
    scopes
    Type
    string[]
    Description

    An array of scopes that define what the API key can access.

  • Name
    secret?
    Type
    string
    Description

    The API key secret. This property is only present in the response from create()JavaScript Icon and cannot be retrieved later.

  • Name
    subject
    Type
    string
    Description

    The user or organization ID that the API key is associated with.

  • Name
    type
    Type
    string
    Description

    The type of the API key. Currently always 'api_key'.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the API key was last updated.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub