Sign in

v2

latestOpenAPI 3.0.02026-07-31172752.6 KB
access_requests

Create an access request

Request access to an application resource. When authenticating with an API token, user_id is required to specify the grantee.

post/api/v1/access_requests

Headers

Idempotency-Keystring

Optional key (1–255 chars) for safely retrying a request. Reusing the same key for the same request returns 409 Conflict and is not processed again — this confirms the request was already received. Keys are retained for 14 days.

Request body

permission_idsstring[] required

List of permission IDs to request

request_reasonstring required

Reason for requesting access

resource_idstring uuid required

Resource ID to request access to

user_idstring uuid

User to request access for. Required when authenticating with an API token. With a user login, defaults to the authenticated user if omitted.

Example request

{
  "permission_ids": [
    "7488a646-e31f-11e4-aace-600308960664"
  ],
  "request_reason": "Need access to complete Q4 reporting",
  "resource_id": "7488a646-e31f-11e4-aace-600308960663"
}

Response

Access request created

application_idstring uuid required

Application ID

durationstring nullable

Duration of time-based access as an ISO 8601 duration (e.g. "PT1H", "P7D"); null for permanent access

expires_atstring date-time nullable

When the time-based access expires; null for permanent access or a time-based request that has not been granted yet

grantee_user_idstring uuid

User ID of the grantee

idstring uuid required

Access request ID

inserted_atstring date-time

Creation timestamp

permission_idsstring[] required

Requested permission IDs

provisioning_type'application_admin' | 'automatic' nullable

Provisioning type

request_reasonstring required

Request reason

requestor_user_idstring uuid

User ID of the requestor

resource_idstring uuid required

Resource ID

status'pending_approval' | 'pending_permissions_assignment' | 'access_granted' | 'denied' | 'rejected' | 'processing_access' | 'scheduled' | 'pending_dependency' required

Current status of the access request

Example response

{
  "application_id": "7488a646-e31f-11e4-aace-600308960662",
  "duration": "PT1H",
  "expires_at": "2023-01-16T10:30:00Z",
  "grantee_user_id": "9488a646-e31f-11e4-aace-600308960666",
  "id": "8488a646-e31f-11e4-aace-600308960665",
  "inserted_at": "2023-01-15T10:30:00Z",
  "permission_ids": [
    "7488a646-e31f-11e4-aace-600308960664"
  ],
  "provisioning_type": "automatic",
  "request_reason": "Need access to complete Q4 reporting",
  "requestor_user_id": "9488a646-e31f-11e4-aace-600308960666",
  "resource_id": "7488a646-e31f-11e4-aace-600308960663",
  "status": "pending_approval"
}