Aggiornare una directory

PATCH /v1/directories/{directory_id} · autorizzazione directories:write

Aggiorna il nome della directory e le sue impostazioni di provisioning con un JSON merge patch (RFC 7396, Content-Type: application/merge-patch+json). If-Match è obbligatorio; il valore corrente è l'header ETag di GET /v1/directories/{directory_id}. Nessun campo accetta null. Una patch che non modifica nulla non scrive nulla e mantiene la versione. La scrittura viene registrata nell'audit come directory.updated, con il valore precedente e quello nuovo di ogni impostazione modificata.

provisioning_mode non può cambiare finché la directory ha record utente non eliminati (409 conflict); elimina la directory e ricreala.
attribute_allowlist viene sostituita per intero. Un attributo rimosso dalla lista viene eliminato dai record utente della directory nella stessa transazione.
mass_deprovision_guard può essere modificato parzialmente; i sotto-campi omessi vengono mantenuti.

Richiesta

Campo	Tipo	Obbligatorio	Descrizione
`directory_id`	percorso	sì	ID della directory SCIM (`dir_…`).
`If-Match`	header	sì	`ETag` corrente della directory.
`name`	stringa	no	Da 1 a 64 caratteri, senza caratteri di controllo, senza spazi iniziali o finali.
`provisioning_mode`	stringa	no	`user_store` (vengono scritti anche gli utenti dell'ambiente, le appartenenze all'organizzazione e i ruoli di gruppo) oppure `mirror` (vengono conservati solo i record della directory).
`attribute_allowlist`	array	no	Attributi SCIM facoltativi da memorizzare, senza duplicati: `title`, `usertype`, `phonenumbers` e gli attributi dell'estensione enterprise `employeenumber`, `department`, `division`, `costcenter`, `organization`, `manager` (nomi completi `urn:ietf:params:scim:schemas:extension:enterprise:2.0:user:`).
`unverified_domain_action`	stringa	no	Utente il cui dominio email non è verificato: `invite` (appartenenza invitata) oppure `mirror_only` (solo record della directory).
`delete_action`	stringa	no	SCIM `DELETE /Users`: `remove_membership` oppure `delete_user` (elimina l'utente gestito dalla directory).
`on_delete_memberships`	stringa	no	Cosa succede alle appartenenze provenienti da questa directory quando la directory viene eliminata: `keep`, `suspend` oppure `remove`.
`mass_deprovision_guard`	oggetto	no	`enabled` (booleano), `percent` (5–50) e `absolute_min` (10–1000): i deprovisioning che superano entrambe le soglie entro 5 minuti vengono trattenuti in attesa di approvazione.
`send_welcome_email`	booleano	no	Indica se un nuovo utente della directory riceve un'email di attivazione dell'account.

Risposta

200 OK con la directory e il suo nuovo ETag.

{
  "id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "type": "scim",
  "name": "Okta EU",
  "state": "active",
  "base_url": "https://acme.eu.keenauth.app/scim/v2/dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "created_at": "2026-10-19T09:31:00.123456Z",
  "last_request_at": null,
  "provisioning_mode": "user_store",
  "attribute_allowlist": ["title", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:user:department"],
  "unverified_domain_action": "invite",
  "delete_action": "remove_membership",
  "on_delete_memberships": "keep",
  "mass_deprovision_guard": {"enabled": true, "percent": 20, "absolute_min": 25},
  "send_welcome_email": false
}

Errori

HTTP	code	Quando
400	`malformed_request`	Il corpo non è un oggetto JSON.
400	`unknown_field`	La patch contiene un campo che non può essere scritto (ad esempio `state`).
404	`not_found`	La directory non esiste in questo ambiente.
409	`conflict`	`provisioning_mode` cambia mentre la directory ha record utente, oppure la directory è in eliminazione.
412	`precondition_failed`	`If-Match` non corrisponde alla versione corrente.
415	`unsupported_media_type`	`Content-Type` non è `application/merge-patch+json`.
422	`validation_failed`	Un campo è `null` o non valido; l'errore indica il campo (ad esempio `/mass_deprovision_guard/percent` `invalid`).
428	`precondition_required`	`If-Match` manca.
401	`unauthenticated`	La credenziale manca, non è valida o è stata revocata.
403	`insufficient_permissions`	La credenziale non ha il permesso richiesto.
429	`rate_limited`	È stato superato il limite di richieste; riprova dopo il periodo indicato da `Retry-After`.
503	`service_unavailable`	La sincronizzazione delle directory è temporaneamente non disponibile o non configurata in questo deployment; riprova dopo il periodo indicato da `Retry-After`.

Esempio

curl -i -X PATCH "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H 'If-Match: "3"' \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"name":"Okta EU","mass_deprovision_guard":{"percent":20}}'