Skip to main content
PUT
Update App Resource Role

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-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. Team keys must allow every team 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.

Path Parameters

id
string
required

The ID of the role.

Body

application/json
name
string | null

The name of the role. Omit to leave unchanged.

description
string | null

A description of the role. Omit to leave unchanged.

requestsEnabled
boolean | null

Whether requests are enabled for the role. Omit to leave unchanged.

accessPolicyId
string | null

Omit to leave unchanged; an empty string restores the app instance default.

provisioningMethod
Builtin Workflow · object

Provisioning configuration. Exactly one method should be set.

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).

requireFormConfirmation
boolean | null
owners
owners · object

Replaces the role's whole owner set when present (an empty set removes all owners). Omit to leave owners unchanged.

scopedId
string | null

Rekeys the role's scoped id ("role_" + 22 alphanumeric chars); omit to leave it unchanged. Fails for ingested roles and roles on the built-in access resource, whose scoped ids are derived from the parent resource and role name.

Response

200 - application/json

Success

data
data · object

The updated role.