OpenManage Enterprise Version 3.2 and OpenManage Enterprise - Modular Edition Version 1.00.10 RESTful API Guide

PDF

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

Example for ServerType: MANUAL
Input:
{
	"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": “”
}

Output:
{
  "Id": 2714,
  "Name": "Starship",
  "ServerType": "MANUAL",
  "ServerName": ["10.35.195.1"],
  "UserName": "Admin",
  "Password": null,
  "ServerPort": 3268,
  "NetworkTimeOut": 300,
  "SearchTimeOut": 300,
  "CertificateValidation": false,
  "CertificateFile": null
}

Example for ServerType: DNS
Input:
{
  "Name": "AD",
  "ServerType": "DNS",
  "ServerName": [   ],
  "DnsServer":
  [
    "dell.com"
  ],
  "GroupDomain": "dell.com",
  "UserName": null,
  "Password": "",
  "ServerPort": 3269,
  "NetworkTimeOut": 120,
  "SearchTimeOut": 120,
  "CertificateValidation": false,
  "CertificateFile": ""
}

Output:
{
  "Name": "AD",
  "ServerType": "DNS",
  "ServerName":
  [
    "ausdcdell1.dell.com",
    "rdudc12dell01.dell.com",
    "pendc12dell01.dell.com",
    "ausdc12dell02.dell.com",
    "ausdc12dell01.dell.com",
    "limdc12dell01.dell.com",
    "ausdc12dell05.dell.com",
    "ausdc12dell06.dell.com",
    "rdudc12dell02.dell.com",
    "ausdc12dell03.dell.com"
  ],
  "DnsServer":
  [
    "dell.com"
  ],
  "GroupDomain": "dell.com",
  "UserName": null,
  "Password": "",
  "ServerPort": 3269,
  "NetworkTimeOut": 120,
  "SearchTimeOut": 120,
  "CertificateValidation": false,
  "CertificateFile": ""
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
Name	Name of the directory service.
Id	ID of the AD or LDAP server.
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.