Skip to content

All Access Requests

Endpoint: GET /api/access-requests

Description: Returns a paginated list of access requests, ordered by created date descending.

Query Parameters

Parameter Type Required Description
page integer No Page number (1-based). Default: 1.
identityId string (GUID) No Filter by the affected identity.
applicationId string (GUID) No Filter by application.
status string No Filter by status. Values: Pending, Open, Resolved, Completed, Canceled, Scheduled, Snoozed. Case-insensitive.
type string No Filter by action type. Values: Add, Change, Remove, Suspend, Restore. Case-insensitive.

Response Attributes

Field Type Description
items array[object] The result set for the current page.
items[].id string (GUID) Unique identifier of the access request.
items[].kind string Resource type. Always Access Request.
items[].number integer Sequential access request number.
items[].action string Action type. Values: Add, Change, Remove, Suspend, Restore.
items[].status string Current status. Values: Pending, Open, Resolved, Completed, Canceled, Scheduled, Snoozed.
items[].reporter object The user who created the access request.
items[].reporter.id string (GUID) Reporter identity ID.
items[].reporter.name string Reporter display name.
items[].assignee object The identity assigned to fulfill the request. null if unassigned.
items[].assignee.id string (GUID) Assignee identity ID.
items[].assignee.name string Assignee display name.
items[].target object The user or group affected by this request.
items[].target.type string Target type. Values: User, Group.
items[].target.name string Target name (user account name or group name).
items[].target.nomenclature string Group nomenclature. Present only when target.type is Group.
items[].target.affectedIdentity object The identity associated with the target. null for group targets.
items[].target.affectedIdentity.id string (GUID) Identity ID.
items[].target.affectedIdentity.kind string Always Identity.
items[].target.affectedIdentity.firstName string First name.
items[].target.affectedIdentity.lastName string Last name.
items[].target.affectedIdentity.emailAddress string Email address.
items[].target.affectedIdentity.type string Identity type.
items[].target.affectedIdentity.title string Job title.
items[].target.affectedIdentity.company string Company name.
items[].target.affectedIdentity.division string Division name.
items[].target.affectedIdentity.department string Department name.
items[].target.affectedIdentity.office string Office location.
items[].target.affectedIdentity.supervisorName string Supervisor display name.
items[].target.affectedIdentity.createdDate string (ISO 8601) Source system created date.
items[].target.affectedIdentity.updatedDate string (ISO 8601) Source system updated date.
items[].target.affectedIdentity.firstSeenDate string (ISO 8601) First import date.
items[].target.affectedIdentity.inactivatedDate string (ISO 8601) Inactivation date.
items[].target.affectedIdentity.status string Identity status.
items[].target.application object The application this request applies to.
items[].target.application.id string (GUID) Application ID.
items[].target.application.kind string Always Application.
items[].target.application.name string Application name.
items[].target.application.priority string Priority rating.
items[].target.application.isArchived boolean Whether the application is archived.
items[].target.application.lastUpdated string (ISO 8601) Application last updated date.
items[].scheduledStart string (ISO 8601) Scheduled start date. null if not scheduled.
items[].startedOn string (ISO 8601) Date work started. null if not started.
items[].approvedOn string (ISO 8601) Date approved. null if not approved.
items[].resolvedOn string (ISO 8601) Date resolved. null if not resolved.
items[].verifiedOn string (ISO 8601) Date verified. null if not verified.
items[].completedOn string (ISO 8601) Date completed. null if not completed.
items[].canceledOn string (ISO 8601) Date canceled. null if not canceled.
totalCount integer Total matching results across all pages.
page integer Current page number.
pageSize integer Number of results per page. Always 50.
totalPages integer Total number of pages.

Sample Response

{
  "items": [
    {
      "id": "a2b3c4d5-e6f7-8901-2345-6789abcdef01",
      "kind": "Access Request",
      "number": 1042,
      "action": "Remove",
      "status": "Open",
      "reporter": {
        "id": "c4d5e6f7-a8b9-0123-4567-89abcdef0123",
        "name": "Permission Assist"
      },
      "assignee": {
        "id": "e6f7a8b9-c0d1-2345-6789-abcdef012345",
        "name": "Williams, James"
      },
      "target": {
        "type": "User",
        "name": "rjohnson",
        "affectedIdentity": {
          "id": "d4a7e2b1-3f5c-4a8d-9e6b-1c2d3e4f5a6b",
          "kind": "Identity",
          "firstName": "Rachel",
          "lastName": "Johnson",
          "emailAddress": "rjohnson@firstbankofvalkyrie.com",
          "type": "Employee",
          "title": "Teller",
          "company": "First Bank of Valkyrie",
          "division": "Retail Banking",
          "department": "Branch Operations",
          "office": "Uptown Branch",
          "supervisorName": "Davis, Michelle",
          "createdDate": "2022-06-10T12:00:00Z",
          "updatedDate": "2025-10-15T16:30:00Z",
          "firstSeenDate": "2022-06-11T02:00:00Z",
          "inactivatedDate": null,
          "status": "Active"
        },
        "application": {
          "id": "b8c1d2e3-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
          "kind": "Application",
          "name": "Jack Henry Symitar",
          "priority": "Critical",
          "isArchived": false,
          "lastUpdated": "2025-12-01T08:45:00Z"
        }
      },
      "scheduledStart": null,
      "startedOn": "2025-12-02T10:00:00Z",
      "approvedOn": "2025-12-02T09:45:00Z",
      "resolvedOn": null,
      "verifiedOn": null,
      "completedOn": null,
      "canceledOn": null
    }
  ],
  "totalCount": 86,
  "page": 1,
  "pageSize": 50,
  "totalPages": 2
}