Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Users

Assign user roles

Set the roles of a user in an account.

You need the "Assign roles in account" permission to use this endpoint.

put/v2/users/{user_identifier}/roles

Path parameters

user_identifierstring uuid required

The identifier of the user who the roles will be assigned to.

Request body

account_identifierstring uuid

The unique identifier of the account.

role_identifiersstring[] required

List of role identifiers.

Example request

{
  "account_identifier": "00000000-0000-0000-0000-000000000000",
  "role_identifiers": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Response

OK

identifierstring uuid required

The unique identifier of the user.

Example response

{
  "identifier": "00000000-0000-0000-0000-000000000000",
  "roles": [
    {
      "assigned_at": "2023-01-01T10:10:10.000Z",
      "name": "Admin",
      "user_role_identifier": "00000000-0000-0000-0000-000000000000"
    }
  ]
}