1. Docs
  2. API Reference
  3. Create a custom role

Create a custom role

POST/api/v1/roles

Creates a custom role in the active Application for the current Environment from a name and optional description. Without organization_id it is an Environment role, assignable in every organization; with it, the role belongs to that organization and can be held only at its node or beneath it (400 rbac.role_outside_organization elsewhere). The new role is always non-system and starts with no permissions, or with a copy of copy_from_role_id's (an Environment role, or one of the same organization) — otherwise attach permission keys via the role-permissions endpoint. A name already used in the same tier (the Environment's roles, or that organization's own) returns 409. Requires the rbac.manage_roles permission and emits a role.created audit event.

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.

Request body

application/json

namestring Required

Role name, unique among the Environment's roles, or among the organization's own when `organization_id` is set

descriptionstring Optional

Role description

organization_idstring Optional

The organization the role belongs to. Omitted, the role is an Environment role, assignable in every organization; set, it can be held only at the organization's node or beneath it.

copy_from_role_idstring Optional

Start from a copy of this role's permissions (and its description, when none is given). An Environment role, or a role of the same organization. The only way an organization gets its own version of a shared role.

Responses

application/json

  • dataRoleResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

RoleResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/roles" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "organization_id": "string",
    "copy_from_role_id": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "name": "string",
    "scope": "environment",
    "organization_node_id": "string",
    "organization_name": "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
  }
}
 Related endpoints
GETList roles
GETGet a role
PATCHUpdate a role
DELETEDelete a role
GETGet permissions for a role
PUTReplace permissions on a role
 Was this page helpful?

Tell us how we can improve this guide.

Canopy