Get LDAP Configuration
get
/api/v1/configuration/ldapConfig/{id}
Gets the LDAP configuration.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Unique LDAP configuration identifier
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : LdapConfigDetail
Type:
objectLDAP Configuration details
Show Source
-
connectTimeout(optional):
integer
-
groupClassName(optional):
string
-
groupMembershipAttribute(optional):
string
-
groupNameAttribute(optional):
string
-
ldapBaseDN(optional):
string
-
ldapBindDN(optional):
string
-
ldapBindPassword(optional):
string
-
ldapHost(optional):
string
-
ldapId(optional):
string
-
ldapName(optional):
string
-
ldapPort(optional):
integer
-
ldapTLSCACert(optional):
string
-
ldapTLSEnabled(optional):
boolean
-
ldapType(optional):
string
-
tlsRootCACertFileName(optional):
string
-
userClassName(optional):
string
-
userNameAttribute(optional):
string
400 Response
Bad Request
401 Response
Not authorized
404 Response
Invalid parameters
Examples
This endpoint is used to get the details of a specific LDAP configuration in your Blockchain platform.
The following example shows how to generate the LDAP configuration report by submitting a GET request on the REST resource using cURL.
curl -X GET \ http://<hostname>:<port>/api/v1/configuration/ldapConfig/<unique LDAP config identifier>
For example,
curl -X GET \ http://localhost:17070/api/v1/configuration/ldapConfig/a455c6ab-dc36-4553-90c4-bbbb3532bc50
Example of the Response Body
The following example shows the contents of the response body in JSON format:
{
"ldapId": "a455c6ab-dc36-4553-90c4-bbbb3532bc50",
"ldapName": "localLDAP",
"ldapType": "OpenLDAP",
"ldapHost": "10.0.2.15",
"ldapPort": 389,
"ldapTLSEnabled": false,
"ldapBaseDN": "dc=example,dc=org",
"ldapBindDN": "cn=admin,dc=example,dc=org",
"ldapBindPassword": "********",
"userNameAttribute": "cn",
"userClassName": "simpleSecurityObject",
"groupNameAttribute": "cn",
"groupMembershipAttribute": "member",
"groupClassName": "groupOfNames",
"connectTimeout": 30000
}