Skip to main content
POST
Create API access key

التفويضات

Authorization
string
header
مطلوب

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

الترويسات

x-organization-id
string<uuid>
مطلوب

Organization context for multi-tenant operations

الجسم

application/json
name
string
مطلوب

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

Required string length: 1 - 255
مثال:

"SIEM Export Integration"

expiresAt
string | null

Optional expiration timestamp for the API access key credential in ISO 8601 format. Omit for no scheduled expiration.

مثال:

"2027-01-01T00:00:00Z"

keyType
enum<string> | null
افتراضي:user_bound

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

الخيارات المتاحة:
user_bound,
service_account
scopes
enum<string>[]

Permission scopes for the API access key credential. Defaults to [""] (full access). Use "push-ingest:" to restrict the credential to push data ingestion only.

الخيارات المتاحة:
*,
push-ingest:*

الاستجابة

201 - application/json
id
string
مطلوب

Stable API access key identifier

name
string
مطلوب

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

keyType
enum<string>
مطلوب

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.

الخيارات المتاحة:
user_bound,
service_account
boundEmail
string
مطلوب

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

status
enum<string>
مطلوب

API access key status

الخيارات المتاحة:
active,
revoked
createdAt
string<date-time>
مطلوب

Timestamp when the API access key credential was created

createdByUserId
string
مطلوب

Identifier of the user who created this API access key

scopes
string[]
مطلوب

Permission scopes assigned to this API access key

مثال:
secret
string
مطلوب

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