Skip to main content
POST
Rotate API access key

Autorizaciones

Authorization
string
header
requerido

Short-lived bearer access token issued for a Living Security API access key. Send as Authorization: Bearer .

Encabezados

x-organization-id
string<uuid>
requerido

Organization context for multi-tenant operations

Parámetros de ruta

id
string
requerido

API access key identifier to rotate

Respuesta

201 - application/json
id
string
requerido

Stable API access key identifier

name
string
requerido

Human-readable name for the API access key credential, usually the owning integration or automation

keyType
enum<string>
requerido

Credential type for the API access key. user_bound keys are associated with the creating user's identity; service_account keys are intended for non-human service integrations.

Opciones disponibles:
user_bound,
service_account
boundEmail
string
requerido

Email address associated with the API access key credential when the credential is user-bound

status
enum<string>
requerido

API access key status

Opciones disponibles:
active,
revoked
createdAt
string<date-time>
requerido

Timestamp when the API access key credential was created

createdByUserId
string
requerido

Identifier of the user who created this API access key

scopes
string[]
requerido

Permission scopes assigned to this API access key

Ejemplo:
secret
string
requerido

One-time secret access key value. Store it immediately; it cannot be retrieved after creation or rotation.

lastUsedAt
string<date-time> | null

Last time the API access key was used

expiresAt
string<date-time> | null

Expiration timestamp for the API access key credential