api_key.create¶

Creates API Key.

name is a user-readable name for key.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: api_key_create

api_key_create

Type: object

API key configuration data for the new key.

No Additional Properties

Name

Type: string Default: "nobody"

Human-readable name for the API key.

Must be at least 1 characters long

Must be at most 200 characters long

Username

Type: string

Must be at least 1 characters long

Expires At

Default: null

Expiration timestamp for the API key or null for no expiration.

Any of

Option 1
Option 2

Type: stringFormat: date-time

Type: null

ApiKeyEntryWithKey

Type: object

The created API key with the actual key value.

No Additional Properties

Id

Type: integer

Unique identifier for the API key.

Name

Type: string Default: "nobody"

Human-readable name for the API key.

Must be at least 1 characters long

Must be at most 200 characters long

Username

Username associated with the API key or null for system keys.

Any of

Type: string

Must be at least 1 characters long

Type: null

User Identifier

User ID (numeric) or SID (string) that owns this API key.

Any of

Option 1
Option 2

Type: integer

Type: string

Keyhash

Type: string

Hashed representation of the API key (masked for security).

Created At

Type: stringFormat: date-time

Timestamp when the API key was created.

Expires At

Default: null

Expiration timestamp for the API key or null for no expiration.

Any of

Option 1
Option 2

Type: stringFormat: date-time

Type: null

Local

Type: boolean

Whether this API key is for local system use only.

Revoked

Type: boolean

Whether the API key has been revoked and is no longer valid.

Revoked Reason

Reason for API key revocation or null if not revoked.

Any of

Option 1
Option 2

Type: string

Type: null

Key

Type: string

The actual API key value (only returned on creation).

Required roles: API_KEY_WRITE | READONLY_ADMIN

Table Of Contents

Previous topic

Next topic

api_key.create¶

Tuple Validation

Parameter 1: api_key_create

api_key_create

Name

Username

Any of

Expires At

Any of

ApiKeyEntryWithKey

Id

Name

Username

Any of

User Identifier

Any of

Keyhash

Created At

Expires At

Any of

Local

Revoked

Revoked Reason

Any of

Key

Table Of Contents

Previous topic

Next topic

api_key.create¶

Call parameters

Tuple Validation

Parameter 1: api_key_create

api_key_create

name

Name

username Required

Username

Any of

expires_at

Expires At

Any of

Return value

ApiKeyEntryWithKey

id Required

Id

name

Name

username Required

Username

Any of

user_identifier Required

User Identifier

Any of

keyhash Required

Keyhash

created_at Required

Created At

expires_at

Expires At

Any of

local Required

Local

revoked Required

Revoked

revoked_reason Required

Revoked Reason

Any of

key Required

Key