External DocumentationTo learn more, visit the Zscaler Authentication Service documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Display Name Contains | The display name to filter the results by, using a case-insensitive partial match. |
| Limit | The maximum number of records to return per request. The maximum value is 1000. |
| Login Name | A comma-separated list of login names to filter the results by. |
| Login Name Contains | The login name to filter the results by, using a case-insensitive partial match. |
| Offset | The offset from which to start returning results. |
| Return All Pages | Automatically fetch all resources, page by page. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Domain Name | A comma-separated list of domain names to filter the results by. |
| IdP Name | A comma-separated list of identity provider names to filter the results by. |
| Primary Email Contains | The primary email to filter the results by, using a case-insensitive partial match. |
Example Output
{
"pageOffset": 1,
"pageSize": 1,
"totalRecord": 11,
"records": [
{
"loginName": "john.doe@example.com",
"displayName": "John",
"firstName": "John",
"lastName": "Doe",
"primaryEmail": "john.doe@example.com",
"department": {},
"status": true,
"customAttrsInfo": {},
"id": "abc123def456g",
"source": "EXAMPLE_SOURCE",
"idp": {
"id": "xyz789uvw012m",
"name": "Example IdP"
}
}
],
"next_link": "https://example-admin.example.com/admin/api/v1/users?limit=1&offset=2",
"prev_link": "https://example-admin.example.com/admin/api/v1/users?limit=1&offset=0",
"results_total": 11
}