Cisco Secure Access Zero Trust User Devices API, Overview

Zero Trust User Devices

The Cisco Secure Access Zero Trust User Devices API enables you to list the certificates for a user and device, and revoke the device certificates and remove the device in Secure Access. The API has these operations:

  • list the device certificates for the user
  • list the certificates for the device
  • list the counts and status of the certificates for the users
  • revoke the certificates for the user device and remove the device on Secure Access

You can find the Secure Access Zero Trust User Devices API endpoints under the admin scope in the Secure Access API.

Overview

Rate Limits for Zero Trust User Devices

Secure Access enables rate limits on the Zero Trust User Devices API endpoints. For more information, see Rate Limits > Admin.

Request Headers

Unless specified, the Secure Access API endpoints use JSON for all requests and responses.

Note: For POST, PUT, and PATCH operations, set the HTTP Content-Type header to application/json in your API request.

Zero Trust User Devices API Workflow

The Secure Access Zero Trust User Devices API workflow requires that you have the user IDs and the device IDs for the organization. You can get the user IDs by making a request to the Secure Access Reporting API. The device IDs are provided by the Zero Trust User Devices API.

Get Your User IDs

  • Create an API key that includes the reports.utilities:read (Secure Access Reporting API) scope permissions. Generate an access token using your API credentials.
  • Make a request to the Secure Access Reporting API and get your user IDs. For more information, see GET /reports/v2/identities?identitytypes=directory_user.

List the Device Certificates for the User

With a user ID, make an API request to get the device certificates for the user. The API response includes the certificate information and the device ID.

List the Certificates for the Device

With a user ID and device ID, make an API request to get the certificates for the user's device.

Get the Counts and Status of the Device Certificates for the Users

Get the status and number of device certificates for the users.

Revoke the Certificates for the User's Device

With a user ID and device ID, make an API request to revoke the certificates for the user's device and then remove the device on Secure Access.

Zero Trust User Devices API Endpoints