Performing connection and authentication tests for the Active Directory server

Execution permission

You must be a system administrator or a security administrator.

Request line

POST base-URL/security/v1/external-user-storage-test-connection

Request message

Object ID

None.

Query parameters

None.

Body

To perform only a connection test:

{
    "action": "testConnection",
    "connectionUrl": "ldaps://example.com"
}

To perform both a connection test and an authentication test:

{
    "action": "testAuthentication",
    "connectionUrl": "ldaps://example.com",
    "bindDn": "admin@example.com",
    "bindCredential": "password"
}

Attribute	Type	Description
action	string	(Required) Type of test Specify either of the following: testConnection: Specify this attribute to test whether the connection destination specified by the connectionUrl attribute is accessible. testAuthentication: Specify this attribute to test whether the connection destination specified by the connectionUrl attribute is accessible and whether authentication can be performed by using the authentication information specified by the bindDn and bindCredential attributes.
connectionUrl	string	(Required) URL of the connection-destination Active Directory server Specify a URL that starts with ldaps:// or ldap://.
bindDn	string	(Optional) Bind DN If you specified testAuthentication for the action attribute, you must specify this attribute.
bindCredential	string	(Optional) Password for the bind DN If you specified testAuthentication is specified for the action attribute, you must specify this attribute.

Response message

Body

None.

Coding example

curl -v -X POST -H "Content-Type:application/json" -s "https://example.com:443/portal/security/v1/external-user-storage-test-connection" -d @./request.json  -H "Authorization:Bearer eyJhbxxx"