Get LDAP search config for a virtual server
Retrieves the LDAP search configuration if LDAP is the selected mode of operation.
Specify a virtual server ID of 0 to ensure the global LDAP search configuration is retrieved. If the virtual server specified has a global security context, then the global LDAP search configuration will be retrieved, otherwise the LDAP search configuration will be specific to the specified virtual server.
It’s not currently possible to update the LDAP search configuration via the REST API.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/name-services/ldap/search
Parameters
Name | Type | Required | Values | Description |
virtualServerId | URI_PARAM | Y | string/number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
Return codes
Code | Data | Description |
200 | ldapSearchConfig | LDAP search config successfully retrieved. |
400 | Error Message | Missing or invalid request contents. |
404 | Error Message | Requested resource not found. |
500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 200 indicates that the API did not complete successfully.
Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/1/name-services/ldap/search
Response example
HTTP/1.1 200 OK { "ldapSearchConfig": { "common": [ "cn=Users,dc=test,dc=example,dc=com" ], "context": "GLOBAL", "group": [], "host": [], "netgroup": [], "searchSubTree": true, "user": [ "ou=uk-nis,dc=test,dc=example,dc=com", "cn=Users,dc=test,dc=example,dc=com" ] } }