api_key.query¶

Sent on api_key changes.

Type: object

ApiKeyAddedEvent

Type: object
No Additional Properties

Id

Type: integer

ApiKeyEntry

Type: object
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.

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

ApiKeyChangedEvent

Type: object
No Additional Properties

Id

Type: integer

ApiKeyEntry

Type: object
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

ApiKeyRemovedEvent

Type: object
No Additional Properties

Id

Type: integer

Required roles: API_KEY_READ

Table Of Contents

Previous topic

Next topic

api_key.query¶

ApiKeyAddedEvent

Id

ApiKeyEntry

Id

Name

Username

Any of

User Identifier

Any of

Keyhash

Created At

Expires At

Any of

Local

Revoked

Revoked Reason

Any of

ApiKeyChangedEvent

Id

ApiKeyEntry

Id

Name

Username

Any of

User Identifier

Any of

Keyhash

Created At

Expires At

Any of

Local

Revoked

Revoked Reason

Any of

ApiKeyRemovedEvent

Id

Table Of Contents

Previous topic

Next topic

api_key.query¶

ADDED

ApiKeyAddedEvent

id Required

Id

fields Required

ApiKeyEntry

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

CHANGED

ApiKeyChangedEvent

id Required

Id

fields Required

ApiKeyEntry

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

REMOVED

ApiKeyRemovedEvent

id Required

Id