Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
IAM

Partial update an existing role

You need the "Create, update, and delete roles in account" permission to use this endpoint.

patch/v2/iam/roles/{role_identifier}

Path parameters

role_identifierstring uuid required

The identifier of the role that you want to update.

Request body

descriptionstring

Description of the role.

namestring

Name of the role.

permissionsinteger[]

An array of permissions as integers.

Example request

{
  "description": "View Cases",
  "name": "Role name",
  "permissions": [
    1,
    2
  ]
}

Response

UPDATED

OR

Example response

{
  "description": "View Cases",
  "identifier": "00000000-0000-0000-0000-000000000000",
  "name": "Supervisor",
  "permissions": [
    1
  ],
  "users_assigned_count": 1,
  "account_identifier": "00000000-0000-0000-0000-000000000000",
  "created_at": "2023-01-01T10:10:10.000Z",
  "updated_at": "2023-01-01T10:10:10.000Z"
}