# 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
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

Type: integer
Type: string

##

#### Iterations

Type: integer

Number of iterations of PBKDF2-SHA512.

##

#### Salt

Type: string

Base64 encoded salt for API key.

##

#### Stored Key

Type: string

SCRAM StoredKey for API key.

##

#### Server Key

Type: string

SCRAM ServerKey for API key.

##

#### 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

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

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
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

Type: integer
Type: string

##

#### Iterations

Type: integer

Number of iterations of PBKDF2-SHA512.

##

#### Salt

Type: string

Base64 encoded salt for API key.

##

#### Stored Key

Type: string

SCRAM StoredKey for API key.

##

#### Server Key

Type: string

SCRAM ServerKey for API key.

##

#### 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

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

Type: string
Type: null

##

#### ApiKeyRemovedEvent

Type: object
No Additional Properties

##

#### Id

Type: integer

Required roles: API_KEY_READ