ACaccessowl
access_requests

Get an access request

Changed on

Returns a single access request by its ID.

get/api/v1/access_requests/{id}

Request

  • Base URL
    https://app.accessowl.io
  • URL
    https://app.accessowl.io/api/v1/access_requests/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Access request ID

Response

Access request

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

termination_reasonstring nullable

Reason the request was ended: the denial reason when denied, the provisioner's rejection reason when rejected; null otherwise. The status field says which kind it was.

Example response

{
  "application_id": "7488a646-e31f-11e4-aace-600308960662",
  "approval_steps": [
    {
      "approvers": [
        {
          "decided_at": "2023-01-15T11:00:00Z",
          "decided_by_user_id": "9488a646-e31f-11e4-aace-600308960667",
          "status": "approved",
          "user_id": "9488a646-e31f-11e4-aace-600308960667"
        }
      ],
      "decided_at": "2023-01-15T11:00:00Z",
      "status": "approved",
      "step": 1,
      "strategy": "all"
    },
    {
      "approvers": [
        {
          "decided_at": null,
          "decided_by_user_id": null,
          "status": "pending",
          "user_id": "9488a646-e31f-11e4-aace-600308960668"
        },
        {
          "decided_at": null,
          "decided_by_user_id": null,
          "status": "pending",
          "user_id": "9488a646-e31f-11e4-aace-600308960669"
        }
      ],
      "decided_at": null,
      "status": "pending",
      "step": 2,
      "strategy": "first_to_respond"
    },
    {
      "approvers": [
        {
          "decided_at": null,
          "decided_by_user_id": null,
          "status": "pending",
          "user_id": "9488a646-e31f-11e4-aace-60030896066a"
        }
      ],
      "decided_at": null,
      "status": "pending",
      "step": 3,
      "strategy": "all"
    }
  ],
  "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",
  "termination_reason": null
}

Changes