Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
roleName
string

Exact, case-sensitive role name, unique within the caller's organization. Supply role_name or role_id.

permission
permission · object

A single RBAC permission. Select a resource and one of its supported actions.

roleId
string

Existing role ID. Prefer role_name; if both are supplied they must match.

Response

Success

success
boolean