Mettre à jour un domaine d'organisation

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

Met à jour les paramètres de capture et de routage SSO du domaine avec un JSON merge patch (RFC 7396, Content-Type: application/merge-patch+json). Les deux ne peuvent être activés que pour un domaine verified. Un patch qui ne modifie rien ne change pas la version.

Requête

Champ Type Obligatoire Description
domain_id path oui Identifiant du domaine d'organisation (odm_…).
If-Match en-tête non Facultatif. Lorsqu'il est envoyé, il doit correspondre à l'ETag de la dernière lecture ("<version>").
capture_mode string non off, suggest ou auto_join : ce qui se passe lorsqu'un utilisateur dont l'adresse e-mail appartient à ce domaine se connecte.
sso_routing_enabled boolean non Dirige les connexions de ce domaine vers la connexion SSO de l'organisation.

Corps de la requête :

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

Réponse

200 OK avec le domaine mis à jour et son nouvel 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
}

Erreurs

HTTP code Quand
400 unknown_field Le corps contient un champ absent du schéma ou en lecture seule.
404 not_found Aucun domaine d'organisation avec cet identifiant n'existe dans cet environnement.
409 domain_not_verified Le domaine n'est pas verified ; la capture ou le routage SSO ne peuvent pas être activés.
412 precondition_failed If-Match a été envoyé et ne correspond pas à la version actuelle ; relisez le domaine.
422 validation_failed Un champ est null ou a une valeur invalide.
401 unauthenticated L'identifiant est absent, invalide ou révoqué.
403 insufficient_permissions L'identifiant ne dispose pas de l'autorisation requise.
429 rate_limited La limite de débit a été dépassée ; réessayez après la période Retry-After.
503 service_unavailable Une dépendance est temporairement indisponible ; réessayez après la période Retry-After.

Exemple

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