Skip to main content
GET
Get

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow. Request an access token from the token endpoint and send it as Authorization: Bearer <token>.

Path Parameters

id
string<uuid>
required

Id of the access request.

Response

The access request.

One person's request for access, and where it is in its lifecycle.

accessRequestConfigId
string<uuid>
required

Id of the config the request was made against.

activities
object[]
required

Every status the request has passed through, oldest first.

createdAt
string<date-time>
required

When the request was submitted.

currentStatus
enum<string>
required

Where a request is in its lifecycle.

Available options:
Approved,
Cancelled,
Denied,
Expired,
ManualActionRequired,
ManualRevokeRequired,
ManuallyProvisioned,
ManuallyRevoked,
PendingApproval,
Provisioned,
Provisioning,
ProvisioningFailed,
RequestFailed,
Requested,
RevokeRequested,
Revoked,
Revoking,
RevokingFailed,
Superseded
Example:

"PendingApproval"

currentStatusUpdatedAt
string<date-time>
required

When the request entered its current status.

extendedCount
integer
required

How many earlier grants this request extends, counting back through previousAccessRequestId.

hasPendingExtension
boolean
required

True while an extension of this request is in flight. A grant with a pending extension cannot be extended again until it is decided.

id
string<uuid>
required

Id of this access request.

Example:

"3c6e0b8a-9f1d-4a2e-8b7c-5d4f3e2a1b0c"

peerGroupRating
enum<string>
required
Available options:
High,
Low,
Medium,
Unavailable
requester
object
required

A person, by name and email.

subject
object
required

The thing a config governs. type says which of application, customAction or directIntegration is set.

accessDurationMinutes
integer | null

Duration the requester asked for, in minutes. Null for permanent access.

accessDurationUnit
enum<string> | null

The unit a duration is shown in. Durations are always sent in minutes.

Available options:
Days,
Hours
application
object | null

The application an application subject grants access to. Null for other subjects.

approvalChainName
string | null

Name of the approval chain deciding this request.

grantedAt
string<date-time> | null

When access was provisioned. Null until then.

justification
string | null

Why the requester needs this access.

parameterResponses
object[] | null

Values the requester entered for a custom action's parameters. Null for other subjects.

peerGroupMetrics
object | null

How many of the requester's peers hold this access, now and over the last 30 and 90 days. A null window has no data yet, which is not the same as zero.

peerGroupPercent
integer | null

Percentage of the requester's peers who hold the same access.

pendingExtensionId
string<uuid> | null

Id of the in-flight request extending this one, when there is one.

previousAccessRequestId
string<uuid> | null

Id of the grant this request extends. Null for a request that is not an extension.

requestNumber
integer<int64> | null

Short sequential number shown to people and in notifications as #N. Null for requests made before numbering began, and on the response to Create.

reviewDecision
enum<string> | null
Available options:
Approved,
AwaitingTurn,
Cancelled,
NotRequired,
NotSupported,
Pending,
Rejected,
Skipped,
TimedOut
reviewDecisionReason
string | null

Reason given with the overall review decision.

reviewDecisionTime
string<date-time> | null

When the overall review decision was made.

reviewer
object | null

A person, by name and email.

revokeAt
string<date-time> | null

When provisioned access is scheduled to be revoked. Null for permanent access and for requests that were never provisioned.

selectedDirectIntegrationGroupConfig
object | null

A group or role of a direct integration that people can request.

selectedDirectIntegrationRoleConfig
object | null

A group or role of a direct integration that people can request.

selectedGroupAssignmentConfig
object | null

One group a requester of an application can ask to be added to.

supersededByAccessRequestId
string<uuid> | null

Id of the extension that took over this grant once it was provisioned. Null while this request is the active grant.