Skip to main content
POST
Create an App Access Role

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body for creating or updating an App Access Role. Pass UIDs (not objects) for relationship fields.

name
string
application
string

The application this Role grants access to. Required on create, immutable afterwards. Pass the UID of the related object.

approval_policy
string | null

The approval policy used when approval_mode is approval_policy. Defaults to the company default policy. Pass the UID of the related object.

approval_mode
enum<string>
default:approval_policy
Available options:
approval_policy,
auto_approve,
auto_reject,
skip_approval
business_reason_required
boolean
is_restricted_to_audience
boolean
audience
object

People who can see the record when is_restricted_to_audience is true. A person matches when every matcher matches. Without a status matcher, status = employee is added. Writing it replaces all the matchers.

duration
enum<string>
default:none
Available options:
fixed,
none,
optional,
required,
required_and_limited
max_duration_minutes
integer | null

Required when duration is required_and_limited or fixed

max_duration_unit
enum<string> | null
Available options:
days,
hours,
minutes,
months,
weeks
provisioning_actions
object[]

Replaces the actions run when access is granted: a single action, or an automated action followed by one manual action. At least one is required. Validate against GET /v1/app_access/roles/provisioning_actions_schema.

deprovisioning_actions
object[]

Replaces the actions run when access is revoked: none, a single action, or an automated action followed by one manual action. Validate against GET /v1/app_access/roles/provisioning_actions_schema.

Response

App Access Role created

result
object