Viewing the LDAP connection by using a REST Administration API

System administrators can view the configuration details of the LDAP connection by using a REST Administration API.

You can view the LDAP connection by using a REST Administration API, or by using the Amlen WebUI. For more information about using the Amlen WebUI to view the LDAP connection, see Configuring an LDAP server by using the Amlen WebUI.

To view the LDAP connection details, use the Eclipse Amlen REST API GET method with the following Eclipse Amlen URI:

Note: The command must be capitalized as shown.

http://<admin-endpoint-IP:Port>/ima/v1/configuration/LDAP

The following example shows a GET method to display configuration details of the LDAP connection by using cURL:

curl -X GET http://127.0.0.1:9089/ima/v1/configuration/LDAP

The following example shows a successful example response to the GET method that was used to display configuration details of the LDAP connection:


{
  "Version": "v1",
  "LDAP": {
    "CacheTimeout": 10,
    "UserSuffix": "",
    "GroupCacheTimeout": 300,
    "NestedGroupSearch": false,
    "BindDN": "",
    "URL": "",
    "EnableCache": true,
    "IgnoreCase": true,
    "Enabled": false,
    "GroupIdMap": "",
    "GroupMemberIdMap": "",
    "Timeout": 30,
    "BaseDN": "",
    "UserIdMap": "",
    "GroupSuffix": "",
    "MaxConnections": 100,
    "Certificate": "",
    "Verify": false
  }
}

Because only one LDAP connection can be configured, a GET request does not need a name. The following example shows an unsuccessful example response to the GET method that was used to display configuration details of "MyLDAP1" which does not exist:

curl -X GET http://127.0.0.1:9089/ima/v1/configuration/LDAP/MyLDAP1


       {        
         "Version": "v1",
         "Code": "CWLNA0136",
         "Message": "The item or object cannot be found. Type: LDAP Name: MyLDAP1"
       }