Skip to main content
POST
Create Role

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Alternatively, you can authenticate with a personal access token (PAT) by sending Authorization: Basic base64(email:PAT).

Scopes

management:roles:write

Write access to role resources.

Body

application/json
name
string
required

Unique display name within the account.

permissions
object[]
required

Connection-level permission grants.

description
string

What this role permits.

Response

Created

id
string<uuid>

Role identifier.

name
string

Role display name.

type
enum<string>

system_role: built-in, non-modifiable. access_role: custom, fully manageable.

Available options:
system_role,
access_role
description
string | null

What the role permits.

permissions
object[]

Connection permissions. Returned only for access_role roles on single-role responses.

created_at
string<date-time> | null

ISO 8601 UTC. null for system roles.

created_by
string<uuid> | null

The user who created the role. null for system roles.

Last modified on November 12, 2026