Skip to main content

Primary key

document_id
uuiddefault:"Random UUID"publicrequired
The unique identifier for the API key record.

Specific attributes

description
varcharpublic
A description of the API key.
expiration_date
timestamppublic
The date and time when the API key expires.
Rules: Precision: 6, with timezone
name
varcharpublicrequired
The name of the API key.
Rules: Max length: 255 characters

Foreign keys

account
uuidpublicrequired
The unique identifier of the associated account. Ref: Account Schema

Tracking attributes

created_at
timestamppublic
The timestamp when the API key record was created.
Rules: Precision: 6, with timezone
deleted_at
timestamppublic
The timestamp when the API key record was deleted, if applicable.
Rules: Precision: 6, with timezone
is_actived
booleandefault:"true"public
Indicates whether the API key record is active.
is_deleted
booleandefault:"false"public
Indicates whether the API key record has been deleted.
updated_at
timestamppublic
The timestamp when the API key record was last updated.
Rules: Precision: 6, with timezone