Skip to main content
GET
/
audits
/
{auditId}
/
personnel
/
groups
Java
package hello.world;

import com.vanta.vanta_auditor_api.Vanta;
import com.vanta.vanta_auditor_api.models.operations.ListPersonnelGroupsRequest;
import com.vanta.vanta_auditor_api.models.operations.ListPersonnelGroupsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Vanta sdk = Vanta.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        ListPersonnelGroupsRequest req = ListPersonnelGroupsRequest.builder()
                .auditId("<id>")
                .build();

        ListPersonnelGroupsResponse res = sdk.audits().listPersonnelGroups()
                .request(req)
                .call();

        if (res.paginatedResponsePersonnelGroup().isPresent()) {
            System.out.println(res.paginatedResponsePersonnelGroup().get());
        }
    }
}
{
  "results": {
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": false,
      "startCursor": "5f2c939a52855e725c8d5824",
      "endCursor": "5f2c939a52855e725c8d5824"
    },
    "data": [
      {
        "id": "5f2c939a52855e725c8d5824",
        "name": "Engineering",
        "members": 42,
        "source": "Okta",
        "tasks": [
          {
            "name": "Security Training"
          },
          {
            "name": "Policy Acceptance"
          }
        ],
        "tasksLastUpdated": "2024-06-15T10:30:00.000Z",
        "pointOfContact": "Jane Doe"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.vanta.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
search
string

Search term for filtering by group name

​
sourcesMatchesAny
string[]

Filter groups by IDP source service names

​
orderBy
enum<string>

Field to sort results by. Allowed: "name", "members", "source", "tasksLastUpdated", "pointOfContact". Default: "name"

Available options:
name,
members,
source,
tasksLastUpdated,
pointOfContact
​
orderDirection
enum<string>

Sort direction: "asc" or "desc". Default: "asc" Sort direction: "asc" for ascending, "desc" for descending.

Available options:
asc,
desc

Response

200 - application/json

Paginated list of groups with pagination metadata

​
results
object
required