Skip to content
SYLVE

Update Active Directory configuration

PUT
/directory-services/active-directory
curl --request PUT \
  --url https://sylve.lan:8181/api/directory-services/active-directory \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "allowTrustedDomains": true, "clearJoinPassword": true, "computerName": "example", "computerOU": "example", "disableCache": true, "domain": "example", "domainController": "example", "idmapBackend": "example", "idmapSchema": "example", "joinPassword": "example", "joinUsername": "example", "kerberosPrincipal": "example", "keytabId": 1, "rangeHigh": 1, "rangeLow": 1, "realmId": 1, "site": "example", "skipDNSRegistration": true, "trustedDomains": [ { "backend": "example", "domain": "example", "rangeHigh": 1, "rangeLow": 1, "schema": "example" } ], "useDefaultDomain": true, "workgroup": "example" }'

Enrollment passwords are stored encrypted and never returned. A blank or omitted password keeps the saved value; clearJoinPassword explicitly removes it.

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Configuration (does not join the domain)

Media typeapplication/json
object
allowTrustedDomains
boolean
clearJoinPassword
boolean
computerName
string
computerOU
string
disableCache
boolean
domain
string
domainController
string
idmapBackend
string
idmapSchema
string
joinPassword
string
joinUsername
string
kerberosPrincipal
string
keytabId
integer
rangeHigh
integer
rangeLow
integer
realmId
integer
site
string
skipDNSRegistration
boolean
trustedDomains
Array<object>
object
backend
string
domain
string
rangeHigh
integer
rangeLow
integer
schema
string
useDefaultDomain
boolean
workgroup
string
Examplegenerated
{
  "allowTrustedDomains": true,
  "clearJoinPassword": true,
  "computerName": "example",
  "computerOU": "example",
  "disableCache": true,
  "domain": "example",
  "domainController": "example",
  "idmapBackend": "example",
  "idmapSchema": "example",
  "joinPassword": "example",
  "joinUsername": "example",
  "kerberosPrincipal": "example",
  "keytabId": 1,
  "rangeHigh": 1,
  "rangeLow": 1,
  "realmId": 1,
  "site": "example",
  "skipDNSRegistration": true,
  "trustedDomains": [
    {
      "backend": "example",
      "domain": "example",
      "rangeHigh": 1,
      "rangeLow": 1,
      "schema": "example"
    }
  ],
  "useDefaultDomain": true,
  "workgroup": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
object
allowTrustedDomains
boolean
computerName
string
computerOU
string
disableCache
boolean
domain
string
domainController
string
enabled
boolean
idmapBackend
string
idmapSchema
string
joinPasswordConfigured
boolean
joinUsername
string
joinWarning
string
joined
boolean
kerberosPrincipal
string
keytabId
integer
membershipPending
string
rangeHigh
integer
rangeLow
integer
realmId
integer
site
string
skipDNSRegistration
boolean
trustedDomains
Array<object>
object
backend
string
domain
string
rangeHigh
integer
rangeLow
integer
schema
string
useDefaultDomain
boolean
workgroup
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "allowTrustedDomains": true,
    "computerName": "example",
    "computerOU": "example",
    "disableCache": true,
    "domain": "example",
    "domainController": "example",
    "enabled": true,
    "idmapBackend": "example",
    "idmapSchema": "example",
    "joinPasswordConfigured": true,
    "joinUsername": "example",
    "joinWarning": "example",
    "joined": true,
    "kerberosPrincipal": "example",
    "keytabId": 1,
    "membershipPending": "example",
    "rangeHigh": 1,
    "rangeLow": 1,
    "realmId": 1,
    "site": "example",
    "skipDNSRegistration": true,
    "trustedDomains": [
      {
        "backend": "example",
        "domain": "example",
        "rangeHigh": 1,
        "rangeLow": 1,
        "schema": "example"
      }
    ],
    "useDefaultDomain": true,
    "workgroup": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Section titled “413”

Request Entity Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}