POST Ad Test
Tests if the Active Directory domain controller can be accessed using the credentials in the configuration settings.
Request
URI
POST
https://{api_host}/api/v2/ad/test
COPY
Request Body
ad.post.request
of type(s)
application/json
Optional
{
"enableAD": true,
"domain": "example.com",
"domainServers": [
"host1.example.com",
"host2.example.com",
"host3.example.com"
],
"username": "exampleuser",
"password": "password",
"connType": "CUSTOM",
"port": 636,
"sslOnly": true,
"acceptCert": true
}Responses
200
Successfully verified the connection to Active Directory.
Operation doesn't return any data structure
400
The request failed because the request body either did not contain valid JSON, or did not match the required JSON format.
Returns
error
of type(s)
application/json
{
"errorMessage": "Invalid request body.",
"errorCode": "JSON_FORMAT_ERROR",
"errorDetails": {
"reason": "..."
}
}
string
errorMessage
Required
A message describing the error.
string
errorCode
Optional
A code representing the type of error.
Possible values are :
LIMIT_ERROR,
FIELD_ERROR,
TEST_ERROR,
JSON_FORMAT_ERROR,
LICENSE_ERROR,
VSPHERE_INTEGRATION_ERROR,
VROPS_INTEGRATION_ERROR,
UPGRADE_ERROR,
SEARCH_ERROR,
AGENT_ERROR,
RBAC_COMMON_ERROR,
RBAC_USERS_ERROR,
RBAC_GROUPS_ERROR,
RBAC_ADGROUPS_ERROR,
RBAC_DATASETS_ERROR,
RBAC_VIDM_GROUPS_ERROR,
RBAC_VIDB_GROUPS_ERROR,
SECURITY_ERROR,
DEPLOYMENT_ERROR,
SUPPORT_BUNDLE_ERROR,
LOAD_BALANCER_ERROR,
VIDM_ERROR,
VIDB_ERROR,
QUERY_ERROR,
SSL_CERTIFICATE_ERROR,
PROXY_ERROR,
object
errorDetails
Optional
Dynamic error details, where the field name can vary depending on the request field and error code.
401
Operation doesn't return any data structure
440
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v2/ad/test