Struct AdminApiKey

Source

pub struct AdminApiKey {
    pub created_at: i64,
    pub id: String,
    pub last_used_at: i64,
    pub name: String,
    pub object: String,
    pub owner: AdminApiKeyOwner,
    pub redacted_value: String,
    pub value: Option<String>,
}

Expand description

§on openapi.yaml

AdminApiKey:
  type: object
  description: Represents an individual Admin API key in an org.
  properties:
    object:
      type: string
      example: organization.admin_api_key
      description: The object type, which is always `organization.admin_api_key`
      x-stainless-const: true
    id:
      type: string
      example: key_abc
      description: The identifier, which can be referenced in API endpoints
    name:
      type: string
      example: Administration Key
      description: The name of the API key
    redacted_value:
      type: string
      example: sk-admin...def
      description: The redacted value of the API key
    value:
      type: string
      example: sk-admin-1234abcd
      description: The value of the API key. Only shown on create.
    created_at:
      type: integer
      format: int64
      example: 1711471533
      description: The Unix timestamp (in seconds) of when the API key was created
    last_used_at:
      type: integer
      format: int64
      nullable: true
      example: 1711471534
      description: The Unix timestamp (in seconds) of when the API key was last used
    owner:
      type: object
      properties:
        type:
          type: string
          example: user
          description: Always `user`
        object:
          type: string
          example: organization.user
          description: The object type, which is always organization.user
        id:
          type: string
          example: sa_456
          description: The identifier, which can be referenced in API endpoints
        name:
          type: string
          example: My Service Account
          description: The name of the user
        created_at:
          type: integer
          format: int64
          example: 1711471533
          description: The Unix timestamp (in seconds) of when the user was created
        role:
          type: string
          example: owner
          description: Always `owner`
  required:
    - object
    - redacted_value
    - name
    - created_at
    - last_used_at
    - id
    - owner
  x-oaiMeta:
    name: The admin API key object
    example: |
      {
        "object": "organization.admin_api_key",
        "id": "key_abc",
        "name": "Main Admin Key",
        "redacted_value": "sk-admin...xyz",
        "created_at": 1711471533,
        "last_used_at": 1711471534,
        "owner": {
          "type": "user",
          "object": "organization.user",
          "id": "user_123",
          "name": "John Doe",
          "created_at": 1711471533,
          "role": "owner"
        }
      }