page | number Default: 1 Which page of data are you requesting
Example: page=1 |
limit | number <= 50 Default: 20 How many items are your requesting
Example: limit=10 |
nextPage | string Example: nextPage=d2lraS9hcGkvdjIvcGFnZXM/bGltaXQ9MTAmY3Vyc29yPWV5SnBaQ0k2SWpJM05USTJPVGdpTENKamIyNTBSUGNtUmxjbFpoYkhWbElqb3lOelV5TmprNGZRPT0= |
q | string Filter data by searching for first name, last name, full name, or email
Example: q=John Doe |
employmentStatus | string Filter data to personnel of this employment status
Enum: "CURRENT_EMPLOYEE" "FORMER_EMPLOYEE" "CURRENT_CONTRACTOR" "FORMER_CONTRACTOR" "OUT_OF_SCOPE" "UNKNOWN" "SPECIAL_FORMER_EMPLOYEE" "SPECIAL_FORMER_CONTRACTOR" Example: employmentStatus=CURRENT_EMPLOYEE |
employmentStatuses[] | Array of strings Filter data to personnel of these employment statuses
Items Enum: "CURRENT_EMPLOYEE" "FORMER_EMPLOYEE" "CURRENT_CONTRACTOR" "FORMER_CONTRACTOR" "OUT_OF_SCOPE" "UNKNOWN" "SPECIAL_FORMER_EMPLOYEE" "SPECIAL_FORMER_CONTRACTOR" Example: employmentStatuses[]=CURRENT_EMPLOYEE |
fullCompliance | boolean Filter personnel by a compliance
|
acceptedPoliciesCompliance | boolean Filter personnel by accepted policies compliance
|
identityMfaCompliance | boolean Filter personnel by identity MFA compliance
|
bgCheckCompliance | boolean Filter personnel by background check compliance
|
agentInstalledCompliance | boolean Filter personnel by monitor agent installation compliance
|
passwordManagerCompliance | boolean Filter personnel by password manager compliance
|
autoUpdatesCompliance | boolean Filter personnel by auto updates compliance
|
locationServicesCompliance | boolean Filter personnel by location services compliance
|
hdEncryptionCompliance | boolean Filter personnel by HD encryption compliance
|
antivirusCompliance | boolean Filter personnel by antivirus compliance
|
lockScreenCompliance | boolean Filter personnel by lock screen compliance
|
securityTrainingCompliance | boolean Filter personnel by security training compliance
|
hipaaTrainingCompliance | boolean Filter personnel by HIPAA Training compliance
|
deviceCompliance | boolean Filter personnel by their device compliance
|
multiSecurityTrainingCompliance | boolean Filter personnel by their training compliance
|
multiTrainingComplianceType | string Type of training campaigns (default: SECURITY_TRAINING)
Value: "SECURITY_TRAINING" Example: multiTrainingComplianceType=SECURITY_TRAINING |
offboardingEvidence | boolean Filter personnel by their offboarding evidence compliance
|
groupIds | Array of numbers List of groups to find personnel by
|
sort | string Which type of sort (default: NAME)
Enum: "NAME" "EMPLOYMENT_STATUS" "ACCEPTED_POLICIES" "FULL_COMPLIANCE" "IDENTITY_MFA" "BG_CHECK" "AGENT_INSTALLED" "OS_VERSION" "SERIAL_NUM" "PASSWORD_MANAGER" "AUTO_UPDATES" "HDD_ENCRYPTION" "ANTIVIRUS" "APPS_COUNT" "START_DATE" "SEPARATION_DATE" "LOCK_SCREEN" "SECURITY_TRAINING" "HIPAA_TRAINING" "OFFBOARDING" Example: sort=NAME |
sortDir | string Which direction to sort the data (default: ASC)
Enum: "ASC" "DESC" Example: sortDir=ASC |
mdmSourceType | string Filter data to personnel of this Mdm source type
Enum: "AGENT" "JAMF" "INTUNE" "KANDJI" "JUMPCLOUD" "HEXNODE_UEM" "UNKNOWN" "RIPPLING" "WORKSPACE_ONE" Example: mdmSourceType=AGENT |
inverseMdmSourceTypes[] | Array of strings Inverse filter data to personnel of these Mdm source types
Items Enum: "AGENT" "JAMF" "INTUNE" "KANDJI" "JUMPCLOUD" "HEXNODE_UEM" "UNKNOWN" "RIPPLING" "WORKSPACE_ONE" Example: inverseMdmSourceTypes[]=AGENT |