Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

testLDAP
URL/api/v1/api.php?target=auth&action=testSSHtestLDAP
DescriptionTest basic connectivity to an LDAP server. Does not test actual authenticaion against server.
ReturnsExamples:
SUCCESSFUL: {'success':1, 'id':'12345'}
ERROR: {'success':0, 'message':'unable to add block'}>
Required Parameters
Name
Type
Example
Description
ldapServerSTRINGldap.awesome.comIP or FQDN of the LDAP server.
ldapPortNUMBER 389User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name
ldapModeSTRING SSLOptions are: SSL, TLS, or None.
Optional Parameters

None

Example URL/api/v1/api.php?target=auth&action=testLDAP&ldapPort=389&ldapServer=ldap.awesome.com&ldapMode=None

...