api_key.update

Update API Key id.

Specify reset: true to reset this API Key.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the API key to update.

Parameter 2: api_key_update

api_key_update

Type: object

Updated API key configuration data.

No Additional Properties

name

Name

Type: string

Human-readable name for the API key.

Must be at least 1 characters long

Must be at most 200 characters long

expires_at

Expires At

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

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

reset

Reset

Type: boolean

Whether to regenerate a new API key value for this entry.

Return value

Result

The updated API key (includes key value if reset was performed).

Any of

• ApiKeyEntryWithKey
• ApiKeyEntry

ApiKeyEntryWithKey

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

key Required

Key

Type: string

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

client_key Required

Client Key

Type: string

Pre-computed SCRAM ClientKey.

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

Required roles: API_KEY_WRITE | READONLY_ADMIN