API Guide

Table 30. Attributes (continued)
Attribute name Description
ServerType Server type of the directory—DNS or Manual.
ServerName Server name of the directory service.
UserName User name of the directory service.
Password Password of the directory service.
ServerPort Port of the directory service.
NetworkTimeOut Network timeout value.
SearchTimeOut Search timeout value.
CertificateValidation Enable or disable certificate validation for the directory
service.
CertificateFile Certificate file for authentication.
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestADConnection
This URI enables you to test the Directory Service connection.
POST method for ExternalAccountProvider.TestADConnection
This method tests the Active Directory Service connection.
Description
Tests the Active Directory Service connection.
Privilege SECURITY_SETUP
HTTP response
codes
200
Example for
ServerType:
MANUAL
Example request body
{
"Name": "Starship",
"ServerType": "MANUAL",
"ServerName": ["10.35.195.1", "10.35.195.2"],
"UserName": "test",
"Password": "test@123",
"ServerPort": 3268,
"NetworkTimeOut": 300,
"SearchTimeOut": 300,
"CertificateValidation": true,
"CertificateFile": “”
}
Example for
ServerType:
MANUAL
Example response body
{
"Id": 2714,
"Name": "Starship",
"ServerType": "MANUAL",
"ServerName": ["10.35.195.1"],
"UserName": "Admin",
"Password": null,
"ServerPort": 3268,
"NetworkTimeOut": 300,
Application settings 53