v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB

Organization Roles

Create an organization role

Creates a new organization role with the given name and permissions for an instance. The key must be unique for the instance and start with the 'org:' prefix, followed by lowercase alphanumeric characters and underscores only. You can optionally provide a description for the role and specify whether it should be included in the initial role set. Organization roles support permissions that can be assigned to control access within the organization.

post/organization_roles

Request body

namestring required

The name of the new organization role

keystring required

A unique key for the organization role. Must start with 'org:' and contain only lowercase alphanumeric characters and underscores.

descriptionstring nullable

Optional description for the role

permissionsstring[] nullable

Array of permission IDs to assign to the role

include_in_initial_role_setboolean nullable

Whether this role should be included in the initial role set

Response

Success

object'role' required

idstring required

namestring required

keystring required

descriptionstring nullable required

is_creator_eligibleboolean required

Whether this role is eligible to be an organization creator role

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.