v1

latestOpenAPI 3.0.1Vanta Terms of Service2026-07-26327517821.8 KB
Audits

List account access records for an audit

Retrieves account access population data for an audit.

This endpoint provides access to account access records visible to auditors during an audit engagement. Account access data comes from various sources:

  • IDP Services (Identity Providers): Okta, Azure AD, Google Workspace, OneLogin, PingOne

    • Returns user accounts from identity providers
    • Supports filtering by search and status
  • Role Grants Services: GCP, Azure (when role grants are enabled)

    • Returns accounts with role-based access grants
    • Supports filtering by search and status
  • First-Party Account Services: AWS, Oracle Cloud, Azure (when not using role grants), etc.

    • Returns cloud provider account access records
    • Supports filtering by search and status
  • Received Account Services: External applications (Jira, GitHub, Slack, etc.)

    • Returns user accounts from third-party integrations
    • Supports filtering by search and status

Supports filtering by:

  • search: Searches account names/emails (case-insensitive)
  • status: Filters by account status

Uses cursor-based pagination. To paginate:

  1. Make initial request with desired pageSize
  2. Check results.pageInfo.hasNextPage
  3. Use results.pageInfo.endCursor as pageCursor for next request

The default sort order depends on the service type:

  • Identity provider services (e.g. Okta, Azure AD): sorted by email, ascending
  • Cloud provider services (e.g. AWS, GCP): sorted by account name, ascending
  • Role grant services: sorted by account name, ascending
  • Third-party application services (e.g. GitHub, Jira): sorted by account name, ascending

Sort order cannot be customized via query parameters.

Rate limit: 10 requests / minute.

get/audits/{auditId}/personnel/account-access/{serviceId}

Path parameters

auditIdstring required

The audit ID

serviceIdstring required

The service ID from the /services endpoint

Query parameters

pageSizeinteger

Controls the maximum number of items returned in one response from the API.

Maximum number of results per page (1-100, default 10)

pageCursorstring

A marker or pointer, telling the API where to start fetching items for the subsequent page in a paginated dataset. Note that the requested page will not include the item that corresponds to this cursor but will start from the one immediately after this cursor.

Pagination cursor from previous response

searchstring

Search term for filtering by account name or email

status'ACTIVE' | 'DEACTIVATED' | 'UNKNOWN'

Account status values for account access records. Unified status enum that covers all service types.

Filter by account status

Response

Paginated list of account access records with pagination metadata

Example response

{
  "results": {
    "data": [
      {
        "id": "5f2c939a52855e725c8d5824",
        "accountName": "john.doe@example.com",
        "owner": "John Doe",
        "role": [
          "Admin"
        ],
        "mfa": true,
        "createdDate": "2024-01-15T10:30:00.000Z",
        "deactivatedDate": "2024-06-20T08:00:00.000Z"
      }
    ]
  }
}