api_key.update¶

Update API Key id.

Specify reset: true to reset this API Key.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: api_key_update

api_key_update

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

Expires At

Type: stringFormat: date-time

Type: null

Reset

Type: boolean

Result

Any of

ApiKeyEntryWithKey
ApiKeyEntry

ApiKeyEntryWithKey

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string Default: "nobody"

Must be at least 1 characters long

Must be at most 200 characters long

Username

Any of

Type: string

Must be at least 1 characters long

Type: null

User Identifier

Any of

Option 1
Option 2

Type: integer

Type: string

Keyhash

Type: string

Created At

Type: stringFormat: date-time

Expires At

Default: null

Any of

Option 1
Option 2

Type: stringFormat: date-time

Type: null

Local

Type: boolean

Revoked

Type: boolean

Revoked Reason

Any of

Option 1
Option 2

Type: string

Type: null

Key

Type: string

ApiKeyEntry

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string Default: "nobody"

Must be at least 1 characters long

Must be at most 200 characters long

Username

Any of

Type: string

Must be at least 1 characters long

Type: null

User Identifier

Any of

Option 1
Option 2

Type: integer

Type: string

Keyhash

Type: string

Created At

Type: stringFormat: date-time

Expires At

Default: null

Any of

Option 1
Option 2

Type: stringFormat: date-time

Type: null

Local

Type: boolean

Revoked

Type: boolean

Revoked Reason

Any of

Option 1
Option 2

Type: string

Type: null

Required roles: API_KEY_WRITE | READONLY_ADMIN

Table Of Contents

Previous topic

Next topic

api_key.update¶

Call parameters

Tuple Validation

Parameter 1: id

id

Parameter 2: api_key_update

api_key_update

name

Name

expires_at

Expires At

Any of

reset

Reset

Return value

Result

Any of

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

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