Skip to content

Update a user's role and state

PUT
/api/v1/users/{id}

Replaces the global role and enabled state without changing username or password. ADMIN and CSRF are required.

id
required
string format: uuid

User identifier.

ADMIN update for a user’s global role and enabled state.

object
enabled

Whether the account may authenticate.

boolean
role
required

Replacement global role.

string
Allowed values: ADMIN OPERATOR VIEWER

User updated

Public user administration record. Password hashes and credentials are never exposed.

object
createdAt

Creation timestamp in UTC.

string format: date-time
enabled

Whether the account may authenticate.

boolean
id

User identifier.

string format: uuid
role

Global authorization role.

string
Allowed values: ADMIN OPERATOR VIEWER
updatedAt

Last update timestamp in UTC.

string format: date-time
username

Current username.

string

The request is malformed or fails validation.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

Authentication is required or credentials are invalid.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

The authenticated identity lacks the required permission.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

The requested resource does not exist or is not visible.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference