Test AD Connection

This method allows you to issue an AD connection test in the organizations in Saner Server. It requires name of the organization, integration type, AD username, AD password, AD domain name. Field device name is required if AD was configured via agent integration. If an organization is already AD configured, then only name of the organization is required to issue an AD connection test.
Field ‘usecredential’ and ‘secureldap’ are optional and if its value is not provided, then default value true and false will be used. Also, ‘usecredential’ field is used during agent integration only.
If AD is configured, then only organization field is mandatory to issue test connection.

KeyMeaningMandatoryData Type
organizationName of the organization for which AD connection test will be issuedYesstring
devicenameDevice name associated with AD agent integrationNo (required if agent integration)string
integrationtypeType of integration (server/agent)No (required if testing new configuration)string
usernameActive Directory usernameNo (required if testing new configuration)string
passwordActive Directory passwordNo (required if testing new configuration)string
domainnameActive Directory domain nameNo (required if testing new configuration)string
sslSSL contentNostring
sslverifySSL verification option (yes/no)Nostring
usecredentialIndicates whether credentials are used (default true, agent integration only)Nostring
secureldapIndicates whether secure LDAP is enabled (default false)Nostring
Query Params
string
required

Account name used to identify the User

Body Params
request
object
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json