Skip to main content
GET
Retrieve an App Access Role

Authorizations

Authorization
string
header
required

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

Path Parameters

uid
string
required

The UID of the App Access Role

Query Parameters

expand[]
string[]

Fields to expand into full objects. Example: ?expand[]=assignee_admin&expand[]=tags

Response

App Access Role show

uid
string
read-only

The UID of the App Access Role

name
string

The Role name, unique per application

application

The application this Role grants access to. Pass ?expand[]=field_name for full object.

approval_policy

The approval policy used when approval_mode is approval_policy, null otherwise. Pass ?expand[]=approval_policy for full object.

approval_mode
enum<string>

How access requests for this Role are approved

Available options:
approval_policy,
auto_approve,
auto_reject,
skip_approval
business_reason_required
boolean

Whether requesters must provide a business reason

is_restricted_to_audience
boolean

Whether only the Role audience can request it

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>

Whether requesters must pick an access duration, and whether it is limited or fixed

Available options:
fixed,
none,
optional,
required,
required_and_limited
max_duration_minutes
integer | null

Maximum (or fixed) access duration in minutes, regardless of display unit. Used when duration is required_and_limited or fixed.

max_duration_unit
enum<string> | null

Display unit of max_duration_minutes, which must be divisible by it

Available options:
days,
hours,
minutes,
months,
weeks
provisioning_actions
object[]

Actions run when access is granted. See GET /v1/app_access/roles/provisioning_actions_schema for the accepted shapes.

deprovisioning_actions
object[]

Actions run when access is revoked. See GET /v1/app_access/roles/provisioning_actions_schema for the accepted shapes.

created_at
string<date-time>
read-only

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

updated_at
string<date-time>
read-only

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")