Test the Directory Services connection with optional override settings

post

https://{example.com}/api/directoryservices/test

Ensure the connection to the Directory Service is valid

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

DirectoryServerSettings allows the user to provide an optional set of Directory Service params to be tested

uint64

The ID of the Directory Server settings record to use as a base

apiType

uint8

The type of LDAP directory server to communicate with.
3 == Unknown,
5 == ActiveDirectory,
6 == IdM,
7 == OpenLDAP
8 == Tivoli Directory Service
9 == EntraID
10 == EntraID Owner

basedn

string

Optional Base DN to search from

domain

string

The DNS name of the domain to connecto to

password

string

The password of the supplied user to connect to the directory server with

port

uint16

The port that the directory server is listening on

useFQDN

boolean

Optional flag to indicate whethere to append domain to user/groups names in AD

useTLS

boolean

Use TLS to communicate with the directory server

username

string

The username to connect to the directory server as

verifyCert

boolean

Verify the certificate is trusted and valid

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200ConnectionTest