Skip to main content
Creates a custom role. With base_role_key the role starts with a copy of that role’s permission rules; the copy is independent — later changes to either role do not affect the other. Only the team owner may manage roles.
Permission required: policy:custom_role_manage

Headers

string
Optional. Retrying with the same value replays the first result instead of creating a second role.

Request Body

string
required
Display name
string
Optional. tenant_admin, tenant_member or a custom role key of this team: the new role starts with a copy of that role’s permission rules (later changes to either role do not affect the other). Omit for a role with no permissions. The owner role cannot be a base.
string
Optional description

Response

object

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.