Skip to main content
GET
List of people who are in scope for this audit

Authorizations

Authorization
string
header
required

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

Path Parameters

auditId
string
required

Query Parameters

pageSize
integer<int32>
default:10

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

Required range: 1 <= x <= 100
pageCursor
string

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.

tasksSummaryStatusMatchesAny
enum<string>[]

Filter individuals by those whose tasksSummary status is any of the provided values.

The overall status of a person's outstanding tasks:

  • NONE: There are no tasks.
  • DUE_SOON: At least one task is due soon.
  • OVERDUE: At least one task is overdue. Has a higher priority than DUE_SOON.
  • COMPLETE: All tasks are complete.
  • PAUSED: All tasks are paused.
  • OFFBOARDING_DUE_SOON: At least one offboarding task is due soon.
  • OFFBOARDING_OVERDUE: At least one offboarding task is overdue. Has a higher priority than OFFBOARDING_DUE_SOON.
  • OFFBOARDING_COMPLETE: All offboarding tasks are complete.
Available options:
COMPLETE,
DUE_SOON,
NONE,
OFFBOARDING_COMPLETE,
OFFBOARDING_DUE_SOON,
OFFBOARDING_OVERDUE,
OVERDUE,
PAUSED
taskTypeMatchesAny
enum<string>[]

Requires taskStatusMatchesAny. Includes all people for whom any of the provided taskType values in taskTypeMatchesAny is any of the provided taskStatus values in taskStatusMatchesAny.

The type a task summary falls into. COMPLETE_TRAININGS: The task summary containing security trainings. ACCEPT_POLICIES: The task summary containing policy acceptance. COMPLETE_CUSTOM_TASKS: The task summary containing custom tasks. INSTALL_DEVICE_MONITORING: The task summary containing device monitoring installation. COMPLETE_BACKGROUND_CHECKS: The task summary containing background checks.

Available options:
COMPLETE_TRAININGS,
ACCEPT_POLICIES,
COMPLETE_CUSTOM_TASKS,
COMPLETE_CUSTOM_OFFBOARDING_TASKS,
INSTALL_DEVICE_MONITORING,
COMPLETE_BACKGROUND_CHECKS
taskStatusMatchesAny
enum<string>[]

Requires taskTypeMatchesAny. Includes all people for whom any of the provided taskType values in taskTypeMatchesAny is any of the provided taskStatus values in taskStatusMatchesAny.

The status of a task.

  • COMPLETE: The task has been completed.
  • DUE_SOON: The task is due soon.
  • OVERDUE: The task is overdue.
  • NONE: The task is not assigned.
Available options:
COMPLETE,
DUE_SOON,
OVERDUE,
NONE

Response

200 - application/json

Ok

results
object
required