zia_list_cloud_app_policy
Retrieve canonical cloud-application enum strings (e.g., ONEDRIVE, SHAREPOINT_ONLINE) for ZIA policy rules. Filter by search term or category, with pagination and JMESPath support.
Instructions
List the ZIA policy-engine cloud-application catalog — canonical enum strings (e.g. ONEDRIVE, ONEDRIVE_PERSONAL, SHAREPOINT_ONLINE) consumed by Web DLP, Cloud App Control, File Type Control, Bandwidth Classes, and Advanced Settings. Use this when you need the exact enum to pass into a policy rule's cloud_applications field. Supports server-side filtering (search, app_class, group_results) and JMESPath via the query parameter. Pass app_class to narrow the catalog by category when the user describes a kind of app instead of a specific one — valid values: SOCIAL_NETWORKING, STREAMING_MEDIA, WEBMAIL, INSTANT_MESSAGING, BUSINESS_PRODUCTIVITY, ENTERPRISE_COLLABORATION, SALES_AND_MARKETING, SYSTEM_AND_DEVELOPMENT, CONSUMER, HOSTING_PROVIDER, IT_SERVICES, FILE_SHARE, DNS_OVER_HTTPS, HUMAN_RESOURCES, LEGAL, HEALTH_CARE, FINANCE, CUSTOM_CAPP, AI_ML.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | Server-side substring filter on application name (e.g. 'sharepoint', 'onedrive'). Use this first to narrow results before applying a JMESPath query. | |
| app_class | No | Filter the cloud-application catalog by category (``app_class``). Use this when the user describes a kind of application — e.g. 'webmail', 'AI tools', 'file sharing', 'streaming' — rather than a specific app. Must be one of the canonical ZIA enum values: ``SOCIAL_NETWORKING``, ``STREAMING_MEDIA``, ``WEBMAIL``, ``INSTANT_MESSAGING``, ``BUSINESS_PRODUCTIVITY``, ``ENTERPRISE_COLLABORATION``, ``SALES_AND_MARKETING``, ``SYSTEM_AND_DEVELOPMENT``, ``CONSUMER``, ``HOSTING_PROVIDER``, ``IT_SERVICES``, ``FILE_SHARE``, ``DNS_OVER_HTTPS``, ``HUMAN_RESOURCES``, ``LEGAL``, ``HEALTH_CARE``, ``FINANCE``, ``CUSTOM_CAPP``, ``AI_ML``. The full live list is whatever ``client.zia.cloudappcontrol.get_rule_type_mapping()`` returns. | |
| page | No | Page offset for pagination. | |
| page_size | No | Page size (default 200, maximum 1000). | |
| group_results | No | If true, return application counts grouped by category. | |
| query | No | JMESPath expression for client-side filtering/projection. Examples: '[?contains(name, `Share`)].{id: id, name: name}', '[?app_class==`ENTERPRISE_COLLABORATION`].name'. | |
| service | No | The service to use. | zia |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |