API summary

See the API's various operations for details on their request parameters and response data.

OperationMethodEndpoint
Identity providers (IDPs)
List IDPsGET/mgmt-pop/​idp
Create an IDPPOST/mgmt-pop/​idp
Delete an IDPDELETE/mgmt-pop/​idp/​{idp_id}
Get an IDPGET/mgmt-pop/​idp/​{idp_id}
Modify an IDPPUT/mgmt-pop/​idp/​{idp_id}
Deploy an IDPPOST/mgmt-pop/​idp/​{idp_id}/​deploy
Get an IDP directory membershipGET/mgmt-pop/​idp/​{idp_id}/​directories_membership
Enable ghost to origin (G2O) for an IDPPOST/mgmt-pop/​idp/​{idp_id}/​g2o
Upload metadata of an IDPPOST/mgmt-pop/​idp/​{idp_id}/​metadata
Get an IDP statusGET/mgmt-pop/​idp/​{idp_id}/​status
List IDP directoriesGET/mgmt-pop/​idpdirectory
Create an IDP directoryPOST/mgmt-pop/​idpdirectory
Delete an IDP directoryDELETE/mgmt-pop/​idpdirectory/​{idpdirectory_id}
Get an IDP directoryGET/mgmt-pop/​idpdirectory/​{idpdirectory_id}
Modify an IDP directoryPUT/mgmt-pop/​idpdirectory/​{idpdirectory_id}
Directories
List directoriesGET/mgmt-pop/​directories
Create a directoryPOST/mgmt-pop/​directories
Get user upload statusGET/mgmt-pop/​directories/​createusers/​status/​{cmd_id}
Verify user re-invite statusGET/mgmt-pop/​directories/​reinviteusers/​status/​{cmd_id}
Search a directoryPOST/mgmt-pop/​directories/​search
Verify a directoryPOST/mgmt-pop/​directories/​verify
Check directory verification statusGET/mgmt-pop/​directories/​verify/​{cmd_id}
Delete a directoryDELETE/mgmt-pop/​directories/​{directory_id}
Get a directoryGET/mgmt-pop/​directories/​{directory_id}
Modify a directoryPUT/mgmt-pop/​directories/​{directory_id}
List directory applicationsGET/mgmt-pop/​directories/​{directory_id}/​apps
Bulk create usersPOST/mgmt-pop/​directories/​{directory_id}/​createusers
Bulk delete userPOST/mgmt-pop/​directories/​{directory_id}/​deleteusers
List directory groupsGET/mgmt-pop/​directories/​{directory_id}/​groups
Get a directory groupGET/mgmt-pop/​directories/​{directory_id}/​groups/​{group_id}
List directory group usersGET/mgmt-pop/​directories/​{directory_id}/​groups/​{group_id}/​users
Re-invite user to a cloud directory groupPOST/mgmt-pop/​directories/​{directory_id}/​reinviteusers
Sync a directoryPOST/mgmt-pop/​directories/​{directory_id}/​sync
List directory usersGET/mgmt-pop/​directories/​{directory_id}/​users
Invite an user to a directory groupPOST/mgmt-pop/​directories/​{directory_id}/​users
List users using autocompleteGET/mgmt-pop/​directories/​{directory_id}/​users/​autocomplete
Get a directory userGET/mgmt-pop/​directories/​{directory_id}/​users/​byname/​{user_id}
List directory group membershipsGET/mgmt-pop/​groupmembership
Create a directory group membershipPOST/mgmt-pop/​groupmembership
Delete a directory group membershipDELETE/mgmt-pop/​groupmembership/​{groupmembership_id}
Get a directory group membershipGET/mgmt-pop/​groupmembership/​{groupmembership_id}
Reset MFA user passwordPOST/mgmt-pop/​tenant/​mfa/​reset
Applications
List application metrics for connectorGET/mgmt-pop/​agents/​{agentId}/​app-metrics
List application bundlesGET/mgmt-pop/​appbundle
Create an application bundlePOST/mgmt-pop/​appbundle
Delete an application bundleDELETE/mgmt-pop/​appbundle/​{appBundleId}
Get an application bundleGET/mgmt-pop/​appbundle/​{appBundleId}
Modify an application bundlePUT/mgmt-pop/​appbundle/​{appBundleId}
Deploy an application bundlePOST/mgmt-pop/​appbundle/​{appBundleId}/​deploy
List application categoriesGET/mgmt-pop/​appcategories
Create an application categoryPOST/mgmt-pop/​appcategories
Delete an application categoryDELETE/mgmt-pop/​appcategories/​{appCategoryId}
Get an application categoryGET/mgmt-pop/​appcategories/​{appCategoryId}
Modify an application categoryPUT/mgmt-pop/​appcategories/​{appCategoryId}
List application directoriesGET/mgmt-pop/​appdirectories
Create or delete application directoriesPOST/mgmt-pop/​appdirectories
Get an application directoryGET/mgmt-pop/​appdirectories/​{appDirectoryId}
List application rewrite groupsGET/mgmt-pop/​appgroups
Assign directory groups to applicationsPOST/mgmt-pop/​appgroups
Get an application groupGET/mgmt-pop/​appgroups/​{appGroupId}
List application IDPsGET/mgmt-pop/​appidp
Assign an IDP to an applicationPOST/mgmt-pop/​appidp
Delete an application IDPDELETE/mgmt-pop/​appidp/​{appIdpId}
Get an application IDPGET/mgmt-pop/​appidp/​{appIdpId}
List application audit logs reportsGET/mgmt-pop/​application-reports/​ops/​query
List applicationsGET/mgmt-pop/​apps
Create an applicationPOST/mgmt-pop/​apps
Delete an applicationDELETE/mgmt-pop/​apps/​{applicationId}
Get an applicationGET/mgmt-pop/​apps/​{applicationId}
Modify an applicationPUT/mgmt-pop/​apps/​{applicationId}
List connectors for an applicationGET/mgmt-pop/​apps/​{applicationId}/​agents
Assign connectors to an applicationPOST/mgmt-pop/​apps/​{applicationId}/​agents
Get a connector for an applicationGET/mgmt-pop/​apps/​{applicationId}/​agents/​{agentId}
Deploy an applicationPOST/mgmt-pop/​apps/​{applicationId}/​deploy
Create an edge keyPOST/mgmt-pop/​apps/​{applicationId}/​edgekey
Create a Ghost to Origin keyPOST/mgmt-pop/​apps/​{applicationId}/​g2o
List the groups assigned to an applicationGET/mgmt-pop/​apps/​{applicationId}/​groups
List services for an applicationGET/mgmt-pop/​apps/​{applicationId}/​services
List URL location rulesGET/mgmt-pop/​apps/​{applicationId}/​urllocation
Create a URL location rulePOST/mgmt-pop/​apps/​{applicationId}/​urllocation
Delete a URL location ruleDELETE/mgmt-pop/​apps/​{applicationId}/​urllocation/​{locationId}
Get a URL location ruleGET/mgmt-pop/​apps/​{applicationId}/​urllocation/​{locationId}
Modify a URL location rulePUT/mgmt-pop/​apps/​{applicationId}/​urllocation/​{locationId}
List application versionsGET/mgmt-pop/​apps/​{applicationId}/​versions
Get an application versionGET/mgmt-pop/​apps/​{applicationId}/​versions/​{versionId}
Create a new application version from existingPUT/mgmt-pop/​apps/​{applicationId}/​versions/​{versionId}
Block a user from accessing an IDPPOST/mgmt-pop/​idpblockuser/​idp/​{idp_id}/​block
Unblock a user from accessing an IDPPOST/mgmt-pop/​idpblockuser/​idp/​{idp_id}/​unblock
Connectors
List connectorsGET/mgmt-pop/​agents
Create a connectorPOST/mgmt-pop/​agents
Delete a connectorDELETE/mgmt-pop/​agents/​{uuid_url}
Get a connectorGET/mgmt-pop/​agents/​{uuid_url}
Modify a connectorPUT/mgmt-pop/​agents/​{uuid_url}
Approve a connectorPOST/mgmt-pop/​agents/​{uuid_url}/​approve
List connector system metricsGET/mgmt-pop/​agents/​{uuid_url}/​system-metrics
Upgrade OS packages on a connectorPOST/mgmt-pop/​agents/​{uuid_url}/​upgrade-os-pkgs
Certificates
List certificatesGET/mgmt-pop/​certificates
Create a certificatePOST/mgmt-pop/​certificates
List CA certificate attributesGET/mgmt-pop/​certificates/​ca_attributes
Delete a certificateDELETE/mgmt-pop/​certificates/​{certificateId}
Get a certificateGET/mgmt-pop/​certificates/​{certificateId}
Modify a manual certificatePUT/mgmt-pop/​certificates/​{certificateId}
Upload a certificatePOST/mgmt-pop/​certificates/​{certificateId}/​upload
Rules
List rulesGET/mgmt-pop/​services
Create a rulePOST/mgmt-pop/​services
Delete a ruleDELETE/mgmt-pop/​services/​{id}
Get a ruleGET/mgmt-pop/​services/​{id}
Modify a rulePUT/mgmt-pop/​services/​{id}
Create an access control rulePOST/mgmt-pop/​services/​{id}/​rules
Modify an access control rulePUT/mgmt-pop/​services/​{id}/​rules
Device posture
Get device historyGET/device-posture/​inventory/​device-history/​{deviceId}
Update device status to clearPUT/device-posture/​inventory/​device/​{deviceId}/​op/​clear
List device inventoryGET/device-posture/​inventory/​list
List anti-malware statusGET/device-posture/​inventory/​summary/​anti-malware-status
List browser activityGET/device-posture/​inventory/​summary/​browsers
List devices with biometricsGET/device-posture/​inventory/​summary/​device-biometric
List jailbroken devicesGET/device-posture/​inventory/​summary/​device-jailbroken
List device activityGET/device-posture/​inventory/​summary/​device-roll-ups
List device screen lockGET/device-posture/​inventory/​summary/​device-screen-lock
List firewall statusGET/device-posture/​inventory/​summary/​firewall-status
List operating system activityGET/device-posture/​inventory/​summary/​os
List device risk assessmentGET/device-posture/​inventory/​summary/​risk-assessment
List system disk encryptionGET/device-posture/​inventory/​summary/​system-disk-encryption
List available browser versionsGET/device-posture/​risk-assessment/​available-browsers
List available client versionsGET/device-posture/​risk-assessment/​available-client-ver
List available operating system versionsGET/device-posture/​risk-assessment/​available-os-ver
Get CA and OCSP informationGET/device-posture/​risk-assessment/​ca-ocsp
List certificate profilesGET/device-posture/​risk-assessment/​certificate-profiles
Create certificate profilePOST/device-posture/​risk-assessment/​certificate-profiles
Delete certificate profileDELETE/device-posture/​risk-assessment/​certificate-profiles/​{certificateProfileId}
Get certificate profileGET/device-posture/​risk-assessment/​certificate-profiles/​{certificateProfileId}
Update certificate profilePUT/device-posture/​risk-assessment/​certificate-profiles/​{certificateProfileId}
List anti-malware profilesGET/device-posture/​risk-assessment/​certificate-usage/​anti-malware-profiles
Create an anti-malware profilePOST/device-posture/​risk-assessment/​certificate-usage/​anti-malware-profiles
Delete an anti-malware profileDELETE/device-posture/​risk-assessment/​certificate-usage/​anti-malware-profiles/​{antiMalwareProfileId}
Get an anti-malware profileGET/device-posture/​risk-assessment/​certificate-usage/​anti-malware-profiles/​{antiMalwareProfileId}
Update an anti-malware profilePUT/device-posture/​risk-assessment/​certificate-usage/​anti-malware-profiles/​{antiMalwareProfileId}
Get CA informationGET/device-posture/​risk-assessment/​certificate-usage/​ca
Get OCSP informationGET/device-posture/​risk-assessment/​certificate-usage/​ocsp
List chosen versionsGET/device-posture/​risk-assessment/​chosen-versions
Modify chosen versionsPUT/device-posture/​risk-assessment/​chosen-versions
Test chosen versionsPOST/device-posture/​risk-assessment/​chosen-versions/​test
List available operating systemsGET/device-posture/​risk-assessment/​os-names
List Carbon Black integrationsGET/device-posture/​risk-assessment/​partner/​carbon-black
Create a new Carbon Black integrationPOST/device-posture/​risk-assessment/​partner/​carbon-black
Get Carbon Black integration statusGET/device-posture/​risk-assessment/​partner/​carbon-black/​status
Update Carbon Black integration statusPUT/device-posture/​risk-assessment/​partner/​carbon-black/​status
Create a Carbon Black integrationPOST/device-posture/​risk-assessment/​partner/​carbon-black/​test
Creates a Carbon Black integration for testingPUT/device-posture/​risk-assessment/​partner/​carbon-black/​test/​{integration_id}
Delete a Carbon Black integrationDELETE/device-posture/​risk-assessment/​partner/​carbon-black/​{integration_id}
Get a Carbon Black integrationGET/device-posture/​risk-assessment/​partner/​carbon-black/​{integration_id}
Modify a Carbon Black integrationPUT/device-posture/​risk-assessment/​partner/​carbon-black/​{integration_id}
List CrowdStrike integrationsGET/device-posture/​risk-assessment/​partner/​crowdstrike
Create a new CrowdStrike integrationPOST/device-posture/​risk-assessment/​partner/​crowdstrike
Get CrowdStrike integration statusGET/device-posture/​risk-assessment/​partner/​crowdstrike/​status
Update CrowdStrike integration statusPUT/device-posture/​risk-assessment/​partner/​crowdstrike/​status
Create a CrowdStrike integrationPOST/device-posture/​risk-assessment/​partner/​crowdstrike/​test
Creates a CrowdStrike integration for testingPUT/device-posture/​risk-assessment/​partner/​crowdstrike/​test/​{integration_id}
Delete a CrowdStrike integrationDELETE/device-posture/​risk-assessment/​partner/​crowdstrike/​{integration_id}
Get a CrowdStrike integrationGET/device-posture/​risk-assessment/​partner/​crowdstrike/​{integration_id}
Modify a CrowdStrike integrationPUT/device-posture/​risk-assessment/​partner/​crowdstrike/​{integration_id}
List signal namesGET/device-posture/​risk-assessment/​signal-names
List risk tagsGET/device-posture/​risk-assessment/​tags
Create risk tagPOST/device-posture/​risk-assessment/​tags
Delete a tagDELETE/device-posture/​risk-assessment/​tags/​{ruleId}
Get a risk tagGET/device-posture/​risk-assessment/​tags/​{ruleId}
Modify a risk tagPUT/device-posture/​risk-assessment/​tags/​{ruleId}
Test risk rulePUT/device-posture/​risk-assessment/​test/​{ruleId}
List risk tiersGET/device-posture/​risk-assessment/​tiers
Get a risk tierGET/device-posture/​risk-assessment/​tiers/​{ruleId}
Modify risk tierPUT/device-posture/​risk-assessment/​tiers/​{ruleId}
List client versionsGET/device-posture/​risk-assessment/​versions/​client_version
Admin events reports
List admin event reportsGET/mgmt-pop/​adminevents-reports/​ops/​reports