Eine Organisationsdomain aktualisieren

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

Aktualisiert die Erfassungs- und SSO-Routing-Einstellungen der Domain mit einem JSON Merge Patch (RFC 7396, Content-Type: application/merge-patch+json). Beide können nur für eine verified-Domain eingeschaltet werden. Ein Patch, der nichts ändert, ändert die Version nicht.

Anfrage

Feld Typ Pflicht Beschreibung
domain_id path ja ID der Organisationsdomain (odm_…).
If-Match Header nein Optional. Wenn gesendet, muss er mit dem ETag der letzten Lesung übereinstimmen ("<version>").
capture_mode string nein off, suggest oder auto_join: was geschieht, wenn sich ein Benutzer mit einer E-Mail-Adresse dieser Domain anmeldet.
sso_routing_enabled boolean nein Anmeldungen mit dieser Domain an die SSO-Verbindung der Organisation weiterleiten.

Anfragetext:

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

Antwort

200 OK mit der aktualisierten Domain und ihrem neuen 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
}

Fehler

HTTP code Wann
400 unknown_field Der Text enthält ein Feld, das nicht im Schema steht oder schreibgeschützt ist.
404 not_found In dieser Umgebung existiert keine Organisationsdomain mit dieser ID.
409 domain_not_verified Die Domain ist nicht verified, daher können Erfassung oder SSO-Routing nicht eingeschaltet werden.
412 precondition_failed If-Match wurde gesendet und stimmt nicht mit der aktuellen Version überein; lesen Sie die Domain erneut.
422 validation_failed Ein Feld ist null oder hat einen ungültigen Wert.
401 unauthenticated Der Berechtigungsnachweis fehlt, ist ungültig oder widerrufen.
403 insufficient_permissions Dem Berechtigungsnachweis fehlt die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; wiederholen Sie nach dem Zeitraum aus Retry-After.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar; wiederholen Sie nach dem Zeitraum aus Retry-After.

Beispiel

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"}'