---
title: "Update Active Directory configuration"
method: PUT
path: "/directory-services/active-directory"
tags: ["Directory Services"]
---

# Update Active Directory configuration

`PUT /directory-services/active-directory`

## Request

- Base URL: `https://sylve.lan:8181/api`
- URL: `https://sylve.lan:8181/api/directory-services/active-directory`
- Auth: API key in header `Authorization`

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

## Request body

- GithubComAlchemillahqSylveInternalServicesDirectoryservicesADInput
  - `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` GithubComAlchemillahqSylveInternalDbModelsDirectoryservicesIDMap[]
    - `backend` string
    - `domain` string
    - `rangeHigh` integer
    - `rangeLow` integer
    - `schema` string
  - `useDefaultDomain` boolean
  - `workgroup` string

## Response `200`

OK

- GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalDbModelsDirectoryservicesActiveDirectory
  - `data` GithubComAlchemillahqSylveInternalDbModelsDirectoryservicesActiveDirectory
    - `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` GithubComAlchemillahqSylveInternalDbModelsDirectoryservicesIDMap[]
      - `backend` string
      - `domain` string
      - `rangeHigh` integer
      - `rangeLow` integer
      - `schema` string
    - `useDefaultDomain` boolean
    - `workgroup` string
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400`: Bad Request
- `409`: Conflict
- `413`: Request Entity Too Large

## Changes

- **2026-10-13** `3b2ab23c2629`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/alchemillahq/apis/sylve-api/changes/directory-services/active-directory/put.md)

---

[API](https://skmtc.dev/alchemillahq/apis/sylve-api.md) - [All operations](https://skmtc.dev/alchemillahq/apis/sylve-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alchemillahq/apis/sylve-api/revisions/9565cdd0abf5?raw)