userdirectory_get
Read-only
Retrieve configured LDAP or SAML user directories to inspect identity provider settings, attribute mappings, and group assignments for centralized authentication and provisioning.
Instructions
Retrieve configured user directories (LDAP or SAML identity providers). User directories enable centralized authentication and automatic user provisioning from external identity stores. Each directory defines connection parameters, attribute mappings, and user group assignments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results to return. | |
| filter | No | Return only results whose properties exactly match the given values (a single value or a list of values per key). Example: {"status": 0} or {"status": [0, 1]}. Only these keys are accepted: userdirectoryid, idp_type (6.4+), provision_status (6.4+). Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the userdirectory object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: userdirectoryid, name, idp_type. Properties: base_dn, bind_dn, description, encrypt_assertions (6.4+), encrypt_nameid (6.4+), group_basedn (6.4+), group_filter (6.4+), group_member (6.4+), group_membership (6.4+), group_name (6.4+), host, idp_certificate_hash (8.0+), idp_entityid (6.4+), idp_type (6.4+), name, nameid_format (6.4+), port, provision_status (6.4+), scim_status (6.4+), search_attribute, search_filter, sign_assertions (6.4+), sign_authn_requests (6.4+), sign_logout_requests (6.4+), sign_logout_responses (6.4+), sign_messages (6.4+), slo_url (6.4+), sp_certificate_hash (8.0+), sp_entityid (6.4+), sp_private_key_hash (8.0+), sso_url (6.4+), start_tls, user_lastname (6.4+), user_ref_attr (6.4+), user_username (6.4+), userdirectoryid, username_attribute (6.4+). | |
| search | No | Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {"name": "web"}. Only these keys are accepted: name, description. | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| raw_json | No | Strips the security disclaimer preamble from the response so it is pure JSON. Default: false. Requires the bearer token to have 'allow_raw_json' explicitly enabled by an operator in the admin portal - tokens without that policy receive a PolicyError instead. WARNING: setting true bypasses the prompt-injection mitigation marker that wraps untrusted Zabbix data (host names, item descriptions, problem text). LLM clients (Claude, GPT, Cursor, ...) should leave this false; only programmatic non-LLM consumers (Python scripts, n8n workflows that json.loads the result) should set true. | |
| sortfield | No | Sort by one or more of: name, host (removed in 6.4) (a list for several; pair with 'sortorder'). No other property is sortable. | |
| sortorder | No | Sort order: 'ASC' (ascending) or 'DESC' (descending). | |
| countOutput | No | Return the count of matching results instead of the actual data. | |
| searchByAny | No | If true, return results matching ANY search field (OR). Default is ALL fields (AND). | |
| extra_params | No | Other native userdirectory.get parameters, merged into the request as-is. Sub-object selects (value 'extend', 'count' or a list of property names): selectProvisionGroups (6.4+), selectProvisionMedia (6.4+), selectUsrgrps. Any other key is refused here, because Zabbix would silently ignore it. For a parameter you are sure exists on your release but is not listed, use zabbix_raw_api_call. | |
| userdirectoryids | No | Return only user directories with the given IDs. | |
| searchWildcardsEnabled | No | If true, enable * and ? wildcards in search patterns. |