Skip to main content
Creates an access group. Its permissions come from an optional base — a role (base_role_key) or another access group (base_access_group_id), fixed at creation — plus its own permission list. Only an owner or admin may create a group based on tenant_admin. A team has at most 200 access groups.
Permission required: access_group:manage
  • Changes that give someone an admin role, or that reduce what an admin can reach, also require the team owner or an admin.

Headers

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

Request Body

string
required
Display name
string
Optional, exclusive with base_role_key. The group grants everything this access group grants.
string
Optional. The group grants everything this role grants. Granting tenant_admin needs an owner or admin. One of: tenant_member, tenant_admin.
string
Optional description
array
Optional permissions on top of the base

Response

object

Errors

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