icon-zpa.svg
Secure Private Access (ZPA)

About SCIM APIs

The SCIM APIs allow you to use custom SCIM clients to make REST API calls to Zscaler. To learn more, see About SCIM and SCIM API Examples.

All SCIM APIs are rate limited. To learn more, contact Zscaler Support.

Operations Supported by the Zscaler SCIM Servers

The following table includes the supported SCIM API operations:

OperationHTTP Request
Endpoints/Users
Fetch All UsersGET
https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Users
Create UserPOST https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Users
Fetch User by IDGET https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Users/{{userId}}
Update User

PUT https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Users/{{userId}}

or

PATCH https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Users/{{userId}}

Delete UserDELETE https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Users/{{userId}}
Endpoints/Groups
Fetch All GroupsGET
https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Groups
Create GroupPOST https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Groups
Fetch Group by IDGET https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Groups/{{groupId}}
Fetch Groups with Pagination and SortGET https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Groups?startIndex=1&count=10&sortBy=displayName&sortOrder=descending
Update Group

PUT
https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Groups/{{groupId}}

or

PATCH https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Groups/{{groupId}}

Delete GroupDELETE
https://{{hostname}}/scim/{{userdb}}/{{idpId}}/v2/Groups/{{groupId}}
Related Articles
About SCIMAbout SCIM UsersAbout SCIM GroupsAbout SCIM Sync LogsAbout SCIM APIsSCIM API ExamplesEnabling SCIM for Identity ManagementDeleting Users in SCIM