Endpoint

/v1/ad/status

GET

Get Active Directory configuration and status.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_ad_status",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "NOT_IN_DOMAIN",
        "JOINED_TO_DOMAIN"
      ],
      "description": "status:\n * `JOINED_TO_DOMAIN` - JOINED_TO_DOMAIN,\n * `NOT_IN_DOMAIN` - NOT_IN_DOMAIN"
    },
    "domain": {
      "description": "domain",
      "type": "string"
    },
    "ou": {
      "description": "ou",
      "type": "string"
    },
    "search_trusted_domains": {
      "description": "search_trusted_domains",
      "type": "boolean"
    },
    "use_ad_posix_attributes": {
      "description": "use_ad_posix_attributes",
      "type": "boolean"
    },
    "base_dn": {
      "description": "base_dn",
      "type": "string"
    },
    "domain_netbios": {
      "description": "domain_netbios",
      "type": "string"
    },
    "dcs": {
      "type": "array",
      "items": {
        "description": "dcs",
        "type": "object",
        "properties": {
          "name": {
            "description": "name",
            "type": "string"
          },
          "address": {
            "description": "address",
            "type": "string"
          }
        }
      }
    },
    "ldap_connection_states": {
      "type": "array",
      "items": {
        "description": "ldap_connection_states",
        "type": "object",
        "properties": {
          "node_id": {
            "description": "node_id",
            "type": "number"
          },
          "servers": {
            "type": "array",
            "items": {
              "description": "servers",
              "type": "object",
              "properties": {
                "bind_uri": {
                  "description": "bind_uri",
                  "type": "string"
                },
                "kdc_address": {
                  "description": "kdc_address",
                  "type": "string"
                }
              }
            }
          },
          "bind_domain": {
            "description": "bind_domain",
            "type": "string"
          },
          "bind_account": {
            "description": "bind_account",
            "type": "string"
          },
          "base_dn_vec": {
            "type": "array",
            "items": {
              "description": "base_dn_vec",
              "type": "string"
            }
          },
          "health": {
            "type": "string",
            "enum": [
              "NO_RECENT_ERROR",
              "INTERMITTENT_ERROR",
              "SUSTAINED_ERROR"
            ],
            "description": "health:\n * `INTERMITTENT_ERROR` - LDAP_HEALTH_INTERMITTENT_ERROR,\n * `NO_RECENT_ERROR` - LDAP_HEALTH_NO_RECENT_ERROR,\n * `SUSTAINED_ERROR` - LDAP_HEALTH_SUSTAINED_ERROR"
          }
        }
      }
    }
  }
}