Skip to main content
POST
Create a role mapping
Creates a mapping so the group’s members receive a role. Use preview first to see how many people change. Applies immediately — the group’s members are re-resolved.
Availability: Cloud · Enterprise (self-hosted). Not available on the Community edition: a self-hosted deployment needs ENTERPRISE_ENABLED=true, otherwise the endpoint answers 403 with error.type: "enterprise_license_required".

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Body

application/json
groupId
string
required
role
enum<string>
required
Available options:
admin,
member
priority
integer

Omit to append at the lowest priority.

Response

The mapping

id
string
groupId
string
groupName
string
role
enum<string>
Available options:
admin,
member
priority
integer

Lower wins when a member belongs to several mapped groups.

memberCount
integer
createdAt
string<date-time>
updatedAt
string<date-time>