ApiCredentialResponse

  • created_at
    Type: stringFormat: date-time
    required

    When the credential was issued.

  • created_by
    Type: UserSummarynullable
    required

    The person who issued the credential, or null if that record is unavailable.

    Properties: 3
  • environment
    Type: CredentialEnvironmentenum
    required

    The environment this credential authenticates against: development or production.

    values
    developmentproduction
  • id
    Type: string
    required

    The credential's stable identifier — the same value that appears in the middle of the bearer token.

  • name
    Type: string
    required

    The name you gave the credential, unique within its environment. How you tell credentials apart once the secret can no longer be read.

  • prefix
    Type: string
    required

    The non-secret leading part of the bearer token, safe to display.

  • revoked_at
    Type: stringFormat: date-timenullable
    required

    When the credential was revoked, or null if it is still active.

  • revoked_by
    Type: UserSummarynullable
    required

    The person who revoked the credential, or null if it is still active.

    Properties: 3
  • status
    Type: ApiCredentialStatusenum
    required

    active until revoked; revoked credentials keep appearing here as the audit trail.

    values
    activerevoked