get_zia_user_groups
Read-only
Retrieve ZIA user groups to manage access control and policies. Filter by group ID or use case-insensitive name match to find groups for assignment.
Instructions
Read ZIA user groups for access control and policy assignment. Pass name="<literal admin-supplied name>" (e.g. name="A000") for a case-insensitive substring match resolved client-side — this is the right knob for find-by-name workflows. Pass group_id= to fetch a single group. The search parameter forwards to the ZIA API and is unreliable for name-based lookups; prefer name.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | No | Operation to perform. Use 'read' to paginate/filter groups or fetch a single group by ID. | read |
| group_id | No | ID of the user group. When provided, returns a single group; otherwise returns a list of groups. | |
| name | No | Case-insensitive substring match on the group's name field. Resolved client-side AFTER fetching the full group list, so names like 'A000', 'a000', 'HR', 'finance' all match regardless of the underlying name's casing. Use this when you have a literal group name from the admin and just need to find its ID. The server-side `search` parameter is unreliable for groups (it sometimes matches user login IDs instead of group names) — prefer `name` for find-by-name workflows. | |
| search | No | Server-side query forwarded to the ZIA list_groups endpoint. ZIA's documented behavior here is unreliable (the API has been observed to match against user login IDs rather than group names). Prefer `name` for case-insensitive substring matching on the group's name. Use `search` only when you specifically need the server-side semantics. | |
| defined_by | No | String value defined by the group name or other applicable attributes. Used to further filter results. | |
| page | No | Page offset for pagination when listing groups. | |
| page_size | No | Page size for listing groups. Default is 100; maximum is 1000. | |
| sort_by | No | Sort field for listing groups. Supported: id, name, expiry, status, external_id, rank, mod_time. | |
| sort_order | No | Sort order for listing groups. Supported: asc, desc, rule_execution. | |
| service | No | Zscaler service name. Always 'zia' for this tool. | zia |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |