Test Ldap

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 
"LdapSettings Object"
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LdapTestResult of type(s) application/json;version=9.1.0 
"LdapTestResult Object"

Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object],[object Object]
Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/cloudapi/1.0.0/ldap/test
On This Page
Ldap Operations
POST
Test Ldap
POST
Sync Ldap
GET
Search Ldap Users
GET
Search Ldap Groups