Getting LDAP server information

You can get information about a registered LDAP server. The LDAP server list will display a maximum of one item because IBM Spectrum Protect Plus supports the registration of only one LDAP server.

Method and URI

To get information about an LDAP server, use a GET method and a URI:

GET     https://{hostname|IP}/api/ldap

Parameters

None.

Data

None.

Example: Get information about an LDAP server

Assume that you registered an LDAP server with IBM Spectrum Protect Plus. A Python snippet that is similar to the following example can be used to request information about the LDAP server:

requests.get('https://' + spp_ipv4 + '/api/ldap',
    headers={...}, verify=...)
_images/reference_ldap_get01.png

Figure 51 The same action can be taken in the IBM Spectrum Protect Plus web user interface: In the navigation pane, click System Configuration > LDAP/SMTP Servers and ensure that the LDAP Server tab is displayed.

The request prompts a response that is structured as shown, with the HTTP status of 200 (OK).

{
    "links": {...},
    "ldapServers": [
        {
            "links": {
                "self": {
                    "rel": "self",
                    "href": "https://10.0.0.111/api/ldap/1012",
                    ...
                },
            ...
            }
            "tenantId": 1000,
            "hostAddress": "10.0.0.111",
            "name": "10.0.0.111",
            "comment": null,
            "user": {
                "href": "https://10.0.0.100/api/identity/user/2148"
            },
            "sslConnection": false,
            "portNumber": 389,
            "baseDN": "DC=BLUEMACHINES,DC=com",
            "userRDN": "OU=SALES",
            "groupRDN": "OU=BM,OU=Security Groups",
            "userFilter": "sAMAccountName={0}",
            "rbacPath": "ldap:0/ldap:1012",
            "resourceType": "ldap",
            "id": "1012"
        }
    ]
}