Aggiornare un dominio dell'organizzazione

PATCH /v1/organization-domains/{domain_id} · autorizzazione organization-domains:write

Aggiorna le impostazioni di cattura e di instradamento SSO del dominio con un JSON merge patch (RFC 7396, Content-Type: application/merge-patch+json). Entrambe possono essere attivate solo per un dominio verified. Una patch che non modifica nulla non cambia la versione.

Richiesta

Campo Tipo Obbligatorio Descrizione
domain_id path sì ID del dominio dell'organizzazione (odm_…).
If-Match header no Facoltativo. Se inviato deve corrispondere all'ETag dell'ultima lettura ("<version>").
capture_mode string no off, suggest oppure auto_join: cosa accade quando un utente con un indirizzo e-mail su questo dominio accede.
sso_routing_enabled boolean no Instrada gli accessi con questo dominio verso la connessione SSO dell'organizzazione.

Corpo della richiesta:

{
  "capture_mode": "suggest",
  "sso_routing_enabled": true
}

Risposta

200 OK con il dominio aggiornato e il nuovo ETag.

{
  "id": "odm_01j9xk3m7q8r2s4t6v8w0y2z4c",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "domain": "acme.com",
  "status": "verified",
  "verification_method": "dns_txt",
  "txt_record_name": "_akp-verify.acme.com",
  "txt_record_value": "idp-verify=EXAMPLEtokenEXAMPLEtokenEXAMPLEtokenEXAMPLEtok",
  "verification_started_at": "2026-10-12T09:30:00.123456Z",
  "verified_at": "2026-10-12T09:35:00.654321Z",
  "last_checked_at": "2026-10-12T09:35:00.654321Z",
  "unverified_at": null,
  "next_check_at": "2026-10-13T09:35:00.654321Z",
  "last_failure_code": null,
  "capture_mode": "suggest",
  "sso_routing_enabled": true,
  "created_at": "2026-10-12T09:30:00.123456Z",
  "updated_at": "2026-10-12T10:05:00.000000Z",
  "version": 3
}

Errori

HTTP code Quando
400 unknown_field Il corpo contiene un campo che non è nello schema o è di sola lettura.
404 not_found In questo ambiente non esiste un dominio di organizzazione con questo ID.
409 domain_not_verified Il dominio non è verified, quindi cattura o instradamento SSO non possono essere attivati.
412 precondition_failed È stato inviato If-Match ma non corrisponde alla versione corrente; rileggere il dominio.
422 validation_failed Un campo è null o ha un valore non valido.
401 unauthenticated La credenziale manca, non è valida o è stata revocata.
403 insufficient_permissions La credenziale non ha l'autorizzazione richiesta.
429 rate_limited È stato superato il limite di frequenza; riprovare dopo il periodo indicato in Retry-After.
503 service_unavailable Una dipendenza è temporaneamente non disponibile; riprovare dopo il periodo indicato in Retry-After.

Esempio

curl -X PATCH https://api.eu.keenauth.com/v1/organization-domains/odm_01j9xk3m7q8r2s4t6v8w0y2z4c \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"capture_mode":"suggest"}'