OpenManage Enterprise Version 3.3.1 and OpenManage Enterprise - Modular Edition Version 1.10.00 RESTful API Guide

PDF

POST method for ExternalAccountProvider.TestLDAPConnection

This method tests the LDAP Directory Service connection.

Description

Tests the LDAP Directory Service connection.

Privilege

SECURITY_SETUP

HTTP response codes

200

Example for ServerType: MANUAL

Example request body


{
 	"Name": "seaquest",
 	"Id":1,
 	"ServerType": "MANUAL",
 	"ServerName": ["10.35.195.1"],
 	"UserName": "Admin",
	 "Password": "",
	 "ServerPort": 636,
 	"BaseDistinguishedName" : "dc=dell,dc=com",
 	"AttributeUserLogin": null,
  "AttributeGroupMembership": null,
	 "NetworkTimeOut": 300,
	 "SearchTimeOut": 300,
	 "CertificateValidation": false,
	 "CertificateFile": ""
}

Example for ServerType: MANUAL

Example response body

{
   "Id": 2914,
   "Name": "seaquest",
   "ServerType": "MANUAL",
   "ServerName": ["10.35.195.1"],
   "UserName": "Admin",
   "Password": null,
   "ServerPort": 636,
   "BaseDistinguishedName": "dc=dell,dc=com",
   "AttributeUserLogin": null,
   "AttributeGroupMembership": null,
   "SearchFilter": null,
   "NetworkTimeOut": 300,
   "SearchTimeOut": 300,
   "CertificateValidation": false,
   "CertificateFile": ""
}

Example for ServerType: DNS

Example request body

{
  "Name": "LDAP",
  "ServerType": "DNS",
  "ServerName": [       ],
  "DnsServer":
  [
    "dell.com"
  ],
  "UserName": null,
  "Password": "",
  "ServerPort": 636,
  "BindDN": null,
  "BindPassword": "",
  "BaseDistinguishedName": "dc=dell,dc=com",
  "AttributeUserLogin": null,
  "AttributeGroupMembership": null,
  "SearchFilter": null,
  "NetworkTimeOut": 120,
  "SearchTimeOut": 120,
  "CertificateValidation": false,
  "CertificateFile": ""
}

Example for ServerType: DNS

Example response body

{
  "Name": "LDAP",
  "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"
  ],
  "UserName": null,
  "Password": "",
  "ServerPort": 636,
  "BindDN": null,
  "BindPassword": "",
  "BaseDistinguishedName": "dc=dell,dc=com",
  "AttributeUserLogin": null,
  "AttributeGroupMembership": null,
  "SearchFilter": null,
  "NetworkTimeOut": 120,
  "SearchTimeOut": 120,
  "CertificateValidation": false,
  "CertificateFile": ""
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
Id	ID of the LDAP account provider.
Name	Directory name.
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.
BaseDistinguishedName	Domain names for search base. Example: dc=dell, dc=com.
AttributeUserLogin	User login details.
AttributeGroupMembership	Group member information.
SearchFilter	Search type.
NetworkTimeOut	Network timeout value.
SearchTimeOut	Search timeout value.
CertificateValidation	Enable or disable certificate validation for the directory service.
CertificateFile	Certificate file for authentication.