Create an organization's own role

POST

/api/v1/organizations/{id}/roles

Creates a role the organization owns, with its permissions, held only at the organization node or beneath it. The name is unique within the organization and may not repeat one of the Environment's roles (409 role.name_taken). An identity may give only permissions it holds at the organization node (403 organization.role_permission_not_held, with the keys in data). An organization owns at most 50 roles (409 organization.role_limit). copy_from_role_id records the role it was copied from. Requires rbac.manage_roles or the organization's roles delegation.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Request body

application/json

namestring Required

Unique within the organization, and not the name of one of the Environment's roles

max length 255

descriptionobject Optional

max length 1000

permission_keysstring[] Required

The permission keys the role carries. A caller signed in as an identity may give only keys it holds at the organization node

copy_from_role_idstring Optional

The role this one was copied from, recorded for provenance: one of the Environment's or the organization's own. The permissions are the ones sent in `permission_keys`

Responses

application/json

dataRoleResponseDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403organization.role_permission_not_heldForbidden

When it happens

The role would carry a permission the editor does not hold at the organization node. <code>data.permission_keys</code> names each one. A permission the role already carries may stay; only one being added must be held.

Remediation

Leave those permissions out, or ask someone who holds them, or the developer, to add them.

409role.name_takenConflict

When it happens

Another role in the same tier already has this name (the Environment's roles, or the same organization's own), or an organization's role was given the name of one of the Environment's.

Remediation

Choose another name, or rename the role that holds it.

409organization.role_limitConflict

When it happens

The organization already owns 50 roles of its own, the most one organization may have. The Environment's roles do not count.

Remediation

Delete a role the organization no longer uses, then create the new one.

Returned object

RoleResponseDtoView all properties on this resource

Request

curl -X POST "https://auth.canopy-io.com/api/v1/organizations/value/roles" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": {},
    "permission_keys": [
      "string"
    ],
    "copy_from_role_id": "string"
  }'

Response

{
  "data": {
    "id": "string",
    "name": "string",
    "scope": "environment",
    "organization_node_id": "string",
    "organization_name": "string",
    "template_id": "string",
    "description": "string",
    "is_system_role": false,
    "system_key": "string",
    "is_active": false,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z",
    "version": 0,
    "permission_count": 0,
    "member_count": 0,
    "administers": false
  }
}

GETWhat the caller administers in an organization
GETList the organization's tree as the caller sees it
GETList who holds a role at a node in the organization
GETSummarize who holds a role at a node in the organization
GETList the roles the caller may grant at a node
GETList the organization's members, for granting a role at a node
POSTGrant a role at a node beneath the organization
PATCHChange a grant in the organization
DELETETake a grant in the organization away
GETList organizations
POSTCreate an organization
DELETEDelete every organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETGet an organization's authentication policy
PATCHUpdate an organization's authentication policy
POSTRegenerate the organization's SSO recovery codes
POSTStart a test sign-in on the organization's connection
GETRead the organization's test sign-in
GETList the organization's domain claims
POSTClaim a domain for the organization
POSTVerify one of the organization's domains
DELETERemove one of the organization's domain claims
GETList an organization's SSO connections
POSTBind an SSO connection to an organization
DELETEUnbind an SSO connection from an organization
GETList an organization's members
POSTAdd a member to an organization
DELETERemove a member from an organization
POSTReset a member's multi-factor authentication
GETList an organization's invitations
POSTInvite a member into an organization
GETList the roles an organization may assign
DELETERevoke an organization invitation
GETGet an organization's SSO connection
POSTSet up an organization's SSO connection
PATCHChange an organization's SSO connection
DELETERemove an organization's SSO connection
POSTActivate an organization's SSO connection
POSTDisable an organization's SSO connection
POSTImport the identity provider's SAML metadata
GETList the connection's recent sign-ins
GETList the roles the organization's SSO sign-ins may arrive with
GETGet the service-provider values for an organization's SSO connection
GETGet an organization's directory connection
POSTCreate an organization's directory connection
DELETERemove an organization's directory connection
GETList an organization's directory-sync tokens
POSTMint a directory-sync token for an organization
POSTReplace a directory-sync token without an outage
DELETERevoke a directory-sync token
GETRecent directory-sync activity for an organization
GETList the roles an organization's directory may grant
PUTReplace the roles an organization's directory may grant
GETList an organization's integrations
POSTCreate an integration
GETList the roles an organization may give its integrations
GETGet one of an organization's integrations
PATCHRename, disable or enable an integration
DELETEDelete an integration
POSTRotate an integration's secret
GETList an integration's roles
POSTGive an integration a role
PATCHChange one of an integration's roles
DELETETake one of an integration's roles away
GETCount an organization's own roles
GETList the permissions a role editor may attach
GETGet one role an organization can use
PATCHRename or describe an organization's own role
DELETEDelete an organization's own role
PUTReplace an organization role's permissions
GETList the groups an organization's provider has pushed
PUTMap a pushed group to one of the available roles
DELETEClear a pushed group's role mapping

Was this page helpful?

Tell us how we can improve this guide.