zid_list_groups
List ZIdentity groups with optional filtering by name, limit, offset, and exclusion of dynamic groups. Returns lean summaries including id, name, description, dynamic flag, and source IdP.
Instructions
List ZIdentity groups.
Read-only. Returns lean group summaries (id, name, description, dynamic
flag, source IdP) rather than the full SDK group record. Pass name for a
case-insensitive partial-name filter.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| limit | No | ||
| query | No | Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Field names are exactly what the Zscaler API returns. Examples: "[?enabled==`true`]", "[*].{name: name, id: id}", "length(@)". Omit to get the full records. | |
| offset | No | ||
| exclude_dynamic_groups | No |