Skip to content

Update a User's Role

PATCH
/api/v1/auth/users/{id}/role
curl --request PATCH \
--url https://example.com/api/v1/auth/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/role \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "role": "owner" }'

Updates a User’s Role. It requires a signed-in User with the admin scope and the admin or owner Role. It also requires a recent passkey check. It can return 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/users/{id}/role. Inputs: id. A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

id
required
string format: uuid

User id

Media typeapplication/json
object
role
required
string
Allowed values: owner admin member guest
Media typeapplication/json
object
code
required
string
message
required
string
Examplegenerated
{
"code": "example",
"message": "example"
}