We've Moved! Product Documentation has moved to docs.hitachivantara.com

Get LDAP config for a virtual server

Last updated
Save as PDF

Retrieves the LDAP configuration if LDAP is the selected mode of operation.

Specify a virtual server ID of 0 to ensure the global LDAP configuration is retrieved. If the virtual server specified has a global security context, then the global LDAP configuration will be retrieved, otherwise the LDAP configuration will be specific to the specified virtual server.

HTTP request syntax (URI)

GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/name-services/ldap

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	ldapConfig	LDAP 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

Response example

HTTP/1.1 200 OK
{
  "ldapConfig": {
    "context": "INDIVIDUAL",
    "domain": "test.example.com",
    "isEnabled": true,
    "ldapVersion": 3,
    "rebindPeriod": 15,
    "schema": "SFU",
    "servers": [
      {
        "dnsName": "",
        "ipAddress": "172.27.128.110",
        "port": 389,
        "tlsPort": 636
      },
      {
        "dnsName": "",
        "ipAddress": "172.27.128.111",
        "port": 389,
        "tlsPort": 636
      }
    ],
    "useTls": true,
    "userName": "cn=ldap,cn=Users,dc=test,dc=example,dc=com"
  }
}

Quick Links