Test Ldap

Test Ldap

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"
    },
    "groupAttributes": {
        "objectClass": "string",
        "objectIdentifier": "string",
        "groupName": "string",
        "membership": "string",
        "membershipIdentifier": "string",
        "backLinkIdentifier": "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

Possible values are : SIMPLE, KERBEROS, M5DIGEST, NTLM,
string
groupSearchBase
Optional

groupSearchBase

boolean
isGroupSearchBaseEnabled
Optional

isGroupSearchBaseEnabled

string
connectorType
Optional

connectorType

Possible values are : ACTIVE_DIRECTORY, OPEN_LDAP,
LdapUserAttributesType
userAttributes
Optional

Defines how LDAP attributes are used when importing a user.

LdapGroupAttributesType
groupAttributes
Optional

Defines how a group is imported from LDAP.

boolean
useExternalKerberos
Optional

useExternalKerberos

string
customUiButtonLabel
Optional

customUiButtonLabel

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LdapTestResult of type(s) application/json;version=39.0 
{
    "connectionTest": {
        "successful": false,
        "error": {
            "minorErrorCode": "string",
            "message": "string",
            "stackTrace": "string"
        }
    },
    "settingsTest": [
        {
            "attribute": "string",
            "attributeValue": "string",
            "result": "string",
            "successful": false
        }
    ]
}
LdapConnectionTestResult
connectionTest
Optional

Provides LDAP connection test results

array of LdapSettingsTestResult
settingsTest
Optional

settingsTest


On This Page
Ldap Operations
GET
Search Ldap Groups
GET
Search Ldap Users
POST
Sync Ldap
POST
Test Ldap