Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
IAM

Create a new role

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

post/v2/iam/roles

Request body

descriptionstring required

Description of the role.

namestring required

Name of the role.

permissionsinteger[] required

List of user permission identifiers

Example request

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

Response

CREATED

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"
}