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. The new role is always non-system and starts with no permissions — attach permission keys via the role-permissions endpoint. A name that already exists in the Environment 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

descriptionstring Optional

Role description

Responses

application/json

  • dataRoleResponseDto*

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"
  }'
Response
{
  "data": {
    "id": "string",
    "application_id": "string",
    "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