Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required

Body

application/json
name
string
required

Role name. Must be unique within the org. Reserved system names (admin, developer, billing, member, user) are rejected.

description
string | null
grants
object[]

Grants this role carries. Empty list is allowed (creates a no-op role; admin can extend it later).

Response

Role created

A role with its full grant set.

created_at
string<date-time>
required
grants
object[]
required

Domain grants this role carries. May be empty.

id
string
required
name
string
required
source
enum<string>
required

Whether a role is a built-in preset or defined by the organization. system roles are read-only; custom roles can be edited or deleted by an organization admin.

Available options:
system,
custom
updated_at
string<date-time>
required
description
string | null