v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Roles

Add a user to a role

Adds a user to a role.

post/api/v2/roles/{role_id}/users

Path parameters

role_idstring required

The unique identifier of the role.

Request body

Example request

{
  "data": {
    "id": "00000000-0000-0000-2345-000000000000",
    "type": "users"
  }
}

Response

Example response

{
  "data": [
    {
      "relationships": {
        "org": {
          "data": {
            "id": "00000000-0000-beef-0000-000000000000",
            "type": "orgs"
          }
        },
        "other_orgs": {
          "data": []
        },
        "other_users": {
          "data": []
        },
        "roles": {
          "data": [
            {
              "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
              "type": "roles"
            }
          ]
        }
      },
      "type": "users"
    }
  ],
  "included": [
    {
      "type": "orgs"
    }
  ]
}