Skip to main content
A newer release of this product is available.

Protocols active-directory endpoint overview

Contributors
PDFs

Overview

You can use this API to display Active Directory account-related information of all SVMs or create a new Active Directory account.

Examples

Retrieving all Active Directory account details of all SVMs

# The API:
GET /api/protocols/active-directory

# The call:
curl -X GET "https://<mgmt-ip>/api/protocols/active-directory?fields=*" -H "accept: application/json"

# The response:
{
"records": [
  {
    "svm": {
      "uuid": "9166c7e8-1fcf-11ed-b037-0050568e9b8b",
      "name": "vs1"
    },
    "organizational_unit": "CN=Computers",
    "name": "SERVER1",
    "fqdn": "EXAMPLE.COM"
  }
],
"num_records": 1
}

Create a new Active Directory account

# The API:
POST /api/protocols/active-directory

# The call:
curl -X POST "https://<mgmt-ip>/api/protocols/active-directory" -H "accept: application/json"
            -d "{  \"force_account_overwrite\": false,  \"fqdn\": \"example.com\",  \"name\": \"account1\", \"password\": \"password\",  \"svm\": {    \"_links\": {},    \"name\": \"vs1\",    \"uuid\": \"6fcfe07a-8a93-11ec-927a-0050568e205f\"  },  \"username\": \"administrator\"}"