Update Role

Rename a custom role or replace its permissions. Members who hold the role get the new permissions. Global roles can't be changed.

PUT

Path

Path parameters

stringrequired

The role's id, from List Roles.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments

string

A new name, up to 255 characters.

string

A new description, up to 255 characters.

array of string

The full new set of permission keys. Replaces the current set.

Response fields

idstring

Unique id of the role.

namestring

The role's name.

descriptionstring

The role's description. Empty when nobody wrote one.

isAdminboolean

True if the role grants admin rights.

isGlobalboolean

True for roles MindCloud provides to every company. Global roles are read-only: writing one answers 404.

createdOndate

When the role was created.

memberCountnumber

How many people in the company hold the role, people whose invite is pending included. A role with members cannot be deleted.

permissionsarray of objects

Everything the role allows, as { key, name } pairs.

keystring
The permission key, such as workflow:run.
namestring
The permission's display name.