Skip to content

Update user role

PATCH
/api/v1/tenant/users/{user_id}

Update a tenant user’s role.

Authorizations

Parameters

Path Parameters

user_id
required

The user ID to update

string format: uuid

The user ID to update

Request Body required

Request body for PATCH /tenant/users/{user_id}.

Attributes: role: New role for the user.

object
role
required
string
>= 1 characters <= 50 characters

Responses

200

Successful Response

Wrapper response for single-user endpoints.

Attributes: data: The user payload.

object
data
required

User record returned by list/invite/update endpoints.

Attributes: id: Unique user identifier. email: User’s email address. name: User’s display name. role: User’s role within the tenant.

object
email
required
string
id
required
string format: uuid
name
required
string
role
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string