Actualizar un dominio de la organización

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

Actualiza la configuración de captura y de enrutamiento SSO del dominio con un JSON merge patch (RFC 7396, Content-Type: application/merge-patch+json). Ambas solo pueden activarse en un dominio verified. Un parche que no cambia nada no modifica la versión.

Solicitud

Campo Tipo Obligatorio Descripción
domain_id path sí ID del dominio de organización (odm_…).
If-Match encabezado no Opcional. Si se envía, debe coincidir con el ETag de la última lectura ("<version>").
capture_mode string no off, suggest o auto_join: qué ocurre cuando un usuario con una dirección de correo de este dominio inicia sesión.
sso_routing_enabled boolean no Enruta los inicios de sesión con este dominio a la conexión SSO de la organización.

Cuerpo de la solicitud:

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

Respuesta

200 OK con el dominio actualizado y su nuevo 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
}

Errores

HTTP code Cuándo
400 unknown_field El cuerpo tiene un campo que no está en el esquema o es de solo lectura.
404 not_found No existe un dominio de organización con este ID en este entorno.
409 domain_not_verified El dominio no está verified, así que no se pueden activar la captura ni el enrutamiento SSO.
412 precondition_failed Se envió If-Match y no coincide con la versión actual; vuelva a leer el dominio.
422 validation_failed Un campo es null o tiene un valor no válido.
401 unauthenticated La credencial falta, no es válida o fue revocada.
403 insufficient_permissions La credencial no tiene el permiso requerido.
429 rate_limited Se superó el límite de frecuencia; reintente después del período de Retry-After.
503 service_unavailable Una dependencia no está disponible temporalmente; reintente después del período de Retry-After.

Ejemplo

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