Test Ldap
Tests LDAP Connection and Settings
Tests that custom LDAP settings are valid, and that the system can use them to search for a user or group
Request
URI
POST
https://{api_host}/cloudapi/1.0.0/ldap/test
COPY
Query Parameters
string
username
Optional
Username to use when testing LDAP search
Request Body
LDAP Settings to use for testing connection
LdapSettings
of type(s)
application/json
Required
{
"hostName": "string",
"port": 0,
"isSsl": false,
"isSslAcceptAll": false,
"realm": "string",
"pagedSearchDisabled": false,
"pageSize": 0,
"maxResults": 0,
"maxUserGroups": 0,
"searchBase": "string",
"userName": "string",
"password": "string",
"authenticationMechanism": "string",
"groupSearchBase": "string",
"isGroupSearchBaseEnabled": false,
"connectorType": "string",
"userAttributes": {
"objectClass": "string",
"objectIdentifier": "string",
"userName": "string",
"email": "string",
"fullName": "string",
"givenName": "string",
"surname": "string",
"telephone": "string",
"groupMembershipIdentifier": "string",
"groupBackLinkIdentifier": "string",
"domain": "string",
"managerIdentifier": "string"
},
"groupAttributes": {
"objectClass": "string",
"objectIdentifier": "string",
"groupName": "string",
"membership": "string",
"membershipIdentifier": "string",
"backLinkIdentifier": "string",
"domain": "string"
},
"useExternalKerberos": false,
"customUiButtonLabel": "string"
}
string
hostName
Optional
hostName
integer
port
Optional
port
boolean
isSsl
Optional
isSsl
boolean
isSslAcceptAll
Optional
isSslAcceptAll
string
realm
Optional
realm
boolean
pagedSearchDisabled
Optional
pagedSearchDisabled
integer
pageSize
Optional
pageSize
integer
maxResults
Optional
maxResults
integer
maxUserGroups
Optional
maxUserGroups
string
searchBase
Optional
searchBase
string
userName
Optional
userName
string
password
Optional
password
string
authenticationMechanism
Optional
authenticationMechanism
Enumeration:
SIMPLE,
KERBEROS,
M5DIGEST,
NTLM
string
groupSearchBase
Optional
groupSearchBase
boolean
isGroupSearchBaseEnabled
Optional
isGroupSearchBaseEnabled
string
connectorType
Optional
connectorType
Enumeration:
ACTIVE_DIRECTORY,
OPEN_LDAP
object
userAttributes
Optional
Defines how LDAP attributes are used when importing a user.
object
groupAttributes
Optional
Defines how a group is imported from LDAP.
boolean
useExternalKerberos
Optional
useExternalKerberos
string
customUiButtonLabel
Optional
customUiButtonLabel
Responses
200
OK
Returns
LdapTestResult
of type(s)
application/json;version=9.1.0
{
"connectionTest": {
"successful": false,
"error": {
"minorErrorCode": "string",
"message": "string",
"stackTrace": "string"
}
},
"settingsTest": [
{
"attribute": "string",
"attributeValue": "string",
"result": "string",
"successful": false
}
]
}Vendor Extension
This operation contains the following vendor extensions defined in the spec:
[{"type":"Classic"},{"type":"Modern"}]
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/cloudapi/1.0.0/ldap/test