Sign in
Users

Assign a role to a user

Assign a role to a user

post/api/v1/users/{id}/roles

Path parameters

idstring uuid required

The user ID

The user ID

Request body

rolestring required

Role in format "scopeType:roleName" or "scopeType:roleName:scopeId"

Example request

{
  "role": "global:admin"
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "role": "global:admin",
    "created_at": "2024-03-19T12:00:00Z"
  }
}

Changes

Changed in 2 of the 8 revisions of this API.11