Endpoint

/v1/ad/join

POST

Joins the cluster to an Active Directory domain.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "ad_domain_join_args",
  "type": "object",
  "properties": {
    "domain": {
      "description": "domain",
      "type": "string"
    },
    "domain_netbios": {
      "description": "domain_netbios",
      "type": "string"
    },
    "user": {
      "description": "user",
      "type": "string"
    },
    "password": {
      "description": "password",
      "type": "string",
      "format": "password"
    },
    "ou": {
      "description": "OU",
      "type": "string"
    },
    "search_trusted_domains": {
      "description": "Allows the cluster to search trusted domains for user information.",
      "type": "boolean"
    },
    "use_ad_posix_attributes": {
      "description": "Use AD POSIX attributes",
      "type": "boolean"
    },
    "base_dn": {
      "description": "Base DN",
      "type": "string"
    },
    "dns_config_id": {
      "description": "The unique ID of the DNS configuration to use for joining this AD domain",
      "type": "number"
    }
  }
}

Response

Codes

Code Description
202 Return value on success