GET Ad

GET Ad

Gets the Active Directory configuration settings.

Request
URI
GET
https://{api_host}/api/v1/ad
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the Active Directory configuration settings.

Returns ad.get.response of type(s) application/json 
{
    "enableAD": true,
    "domain": "example.com",
    "domainServers": [
        "host1.example.com",
        "host2.example.com",
        "host3.example.com"
    ],
    "username": "exampleuser",
    "password": "",
    "connType": "CUSTOM",
    "port": 636,
    "sslOnly": true
}

401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/ad
On This Page
Ad Operations
GET
GET Ad
POST
POST Ad
POST
POST Ad Test