Skip to main content

Managing Admin Single Sign-On Login Configurations Using API

This article provides information on managing Zscaler Private Access (ZPA) administrator single sign-on (SSO) login configuration use cases using APIs. All APIs are rate limited. To learn more, see ZPA API Rate Limits.

Getting SSO Login Configuration Details

To get SSO login details:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/v2/ssoLoginOptions.
  2. Provide the customerId, the ZPA tenant ID of the customer, in the request endpoint. For example: /mgmtconfig/v1/admin/customers/144118148382064640/v2/ssoLoginOptions.

Example Response​

{
  "ssologinonly": false
}

A successful response returns code 200. To learn more, see ZPA API Codes.

Updating SSO Login Configuration Details

To update SSO login configuration details:

  1. Send a POST request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/v2/ssoLoginOptions.
  2. Provide the customerId, the ZPA tenant ID of the customer, in the request endpoint. For example: /mgmtconfig/v1/admin/customers/144118148382064640/v2/ssoLoginOptions.
  3. Include the request headers to provide information about the request context:
    • Content-Type: application/json
    • Authorization: Bearer <access_token>
  4. Use the following JSON payload and pass the ssologinonly field as true (to enable SSO), or false (to disable SSO).

JSON Payload​

{
  "ssologinonly": true
}

A successful response returns code 204, meaning the SSO login configuration is updated. To learn more, see ZPA API Codes.