Skip to main content
POST
Create App Resource Role

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
resourceId
string
required

The ID of the resource.

name
string
required

The name of the role.

provisioningMethod
Builtin Workflow · object
required

Provisioning configuration. Exactly one method should be set.

description
string

A description of the role.

requestsEnabled
boolean

Whether requests are enabled for the role.

accessPolicyId
string | null

The default access policy for the role (optional).

externalId
string | null

The external ID of the role in the external system (optional).

externalData
string | null

Data from the external system as a JSON string (optional).

owners
OwnerTarget · object[]

Owners (users/groups) to set on the created role (optional).

scopedId
string | null

Scoped ID to assign to an editable role ("role_" + 22 alphanumeric chars); omit to mint a random ID. The ID is immutable after creation.

Response

200 - application/json

Success

data
data · object

The created role.