icon-zslogin.svg
ZIdentity

About API Clients

An API client refers to any application or service that wants to access the Zscaler API resources and retrieve data. You can configure and manage the API clients in the ZIdentity Admin Portal, along with their authentication information and necessary scope to access the API resources. ZIdentity is the authorization server that validates the API client's request and issues an access token that must be used to access the API resources via the OneAPI server.

API clients include the following key features and benefits:

  • Consistent API experience across all Zscaler services.
  • Consistent authorization through ZIdentity.
  • Access resources across all Zscaler services with entitlements via role-based access control.

About the API Clients Page

On the API Clients page (Integration > API Clients), you can do the following:

  1. Add an API client.
  2. View the list of API clients you've configured. For each API client, you can see:
    • Name: The name of the API client.
    • Client ID: The unique identifier for the API client.
    • Status: The status (Active or Inactive) of the API client.
  3. Reset the page to the default view.
  4. Search for an API client.
  5. Edit an API client.
  6. Delete an API client.
The API client page
Related Articles
Understanding OneAPI AuthenticationAbout API ClientsAdding an API ClientEditing or Deleting an API ClientViewing API ResourcesAbout Access TokensRevoking Access Tokens