Audits

List account access services for an audit

Retrieves connected account access services for an audit.

Returns the list of identity providers and access integrations (such as Okta, Azure AD, Google Workspace, AWS IAM) that are connected to the organization and provide account access data for personnel.

These integrations are used to verify user access and identity management during an audit engagement.

Uses cursor-based pagination. To paginate:

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

Results are returned in connection order. Sort order is not guaranteed and cannot be customized via query parameters.

GET

audits

{auditId}

personnel

account-access

services

TypeScript

import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.audits.listAccountAccessServices({
    auditId: "<id>",
  });

  console.log(result);
}

run();

{
  "results": {
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    },
    "data": [
      {
        "id": "68d17609e79bc56dbe798eac",
        "credentialDisplayName": "Okta - Production",
        "subAccountId": null,
        "service": "okta"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

auditId

string

required

The audit ID

Query Parameters

pageSize

integer<int32>

default:10

Maximum number of results per page (1-100, default 10) Controls the maximum number of items returned in one response from the API.

Required range: 1 <= x <= 100

pageCursor

string

Pagination cursor from previous response 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.

Response

200 - application/json

Paginated list of connected account access services

results

object

required

Show child attributes

List account access records for an auditRetrieves 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.

⌘I

TypeScript

import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.audits.listAccountAccessServices({
    auditId: "<id>",
  });

  console.log(result);
}

run();

{
  "results": {
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    },
    "data": [
      {
        "id": "68d17609e79bc56dbe798eac",
        "credentialDisplayName": "Okta - Production",
        "subAccountId": null,
        "service": "okta"
      }
    ]
  }
}