api_key.query

Sent on api_key changes.

Type: object

ADDED

ApiKeyAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

ApiKeyEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the API key.

name

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 Required

Username

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

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

user_identifier Required

User Identifier

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

Any of

• Option 1
• Option 2

Type: integer

Type: string

iterations Required

Iterations

Type: integer

Number of iterations of PBKDF2-SHA512.

salt Required

Salt

Type: string

Base64 encoded salt for API key.

stored_key Required

Stored Key

Type: string

SCRAM StoredKey for API key.

server_key Required

Server Key

Type: string

SCRAM ServerKey for API key.

created_at Required

Created At

Type: stringFormat: date-time

Timestamp when the API key was created.

expires_at

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 Required

Local

Type: boolean

Whether this API key is for local system use only.

revoked Required

Revoked

Type: boolean

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

revoked_reason Required

Revoked Reason

Reason for API key revocation or null if not revoked.

Any of

• Option 1
• Option 2

Type: string

Type: null

CHANGED

ApiKeyChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

ApiKeyEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the API key.

name

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 Required

Username

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

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

user_identifier Required

User Identifier

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

Any of

• Option 1
• Option 2

Type: integer

Type: string

iterations Required

Iterations

Type: integer

Number of iterations of PBKDF2-SHA512.

salt Required

Salt

Type: string

Base64 encoded salt for API key.

stored_key Required

Stored Key

Type: string

SCRAM StoredKey for API key.

server_key Required

Server Key

Type: string

SCRAM ServerKey for API key.

created_at Required

Created At

Type: stringFormat: date-time

Timestamp when the API key was created.

expires_at

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 Required

Local

Type: boolean

Whether this API key is for local system use only.

revoked Required

Revoked

Type: boolean

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

revoked_reason Required

Revoked Reason

Reason for API key revocation or null if not revoked.

Any of

• Option 1
• Option 2

Type: string

Type: null

REMOVED

ApiKeyRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: API_KEY_READ