Mettre à jour les paramètres de l'environnement

PATCH /v1/environment-settings · autorisation environment-settings:write

Met à jour les paramètres de l'environnement avec un correctif de fusion JSON (application/merge-patch+json, RFC 7396). If-Match est obligatoire : son absence renvoie 428, et une version obsolète renvoie 412. Si les paramètres n'ont jamais été écrits, la version est "0" et la première écriture crée la ligne. Un correctif qui ne modifie rien n'écrit rien et conserve la version.

Requête

Comportement

• Les groupes se fusionnent récursivement : n'envoyez que les champs modifiés dans locales, session, signup, security_notifications, account_recovery et mfa. Un groupe lui-même ne peut pas être null.
• La réduction de la durée d'une session, la baisse de la limite de sessions simultanées, le resserrement de l'inscription ou de la récupération de compte, le passage du second facteur e-mail de mfa à 1fa, ainsi que la suppression d'un facteur de allowed_first_factors, s'appliquent immédiatement aux nouvelles sessions et connexions ; les sessions existantes conservent leur propre durée de vie.
• Les erreurs de validation portent le pointeur JSON du champ, par exemple /session/idle_timeout_s avec le code out_of_range. Une erreur dans une entrée de liste pointe vers l'entrée : /allowed_first_factors/1 avec unknown_value (valeur inconnue) ou duplicate (valeur répétée).
• allowed_first_factors est intersecté avec les politiques de l'application et de l'organisation : elles ne peuvent que restreindre cet ensemble.
• Si le nouvel ensemble ne laisse aucune méthode commune avec une application qui possède son propre allowed_first_factors, la requête renvoie 422 policy_conflict ; modifiez d'abord l'ensemble de l'application.
• L'enregistrement d'audit et l'événement de modification contiennent les noms des champs modifiés, jamais leurs valeurs. La protection contre les attaques est une ressource distincte et ne fait pas partie de celle-ci.

Réponse

200 OK avec les paramètres mis à jour et le nouvel ETag.

{
  "locales": {"enabled": ["en", "tr"], "default": "tr"},
  "default_zoneinfo": "Europe/Istanbul",
  "session": {"idle_timeout_s": 3600, "absolute_timeout_s": 2592000, "max_concurrent": 5, "concurrent_mode": "evict_oldest", "anomaly_action": "enforce"},
  "signup": {"mode": "invite_only", "email_domain_mode": "allowlist", "email_domains": ["example.com"]},
  "security_notifications": {"enabled": true, "events": ["password_changed", "password_reset"]},
  "account_recovery": {"mode": "self_service_waiting", "waiting_hours": 72, "support_url": ""},
  "mfa": {"email_second_factor_enabled": false, "email_second_factor_acr": "1fa", "totp_issuer_label": "Acme", "recovery_codes_enabled": true, "recovery_code_count": 10, "required": false, "min_acr": "1fa", "enrollment_grace_days": 0},
  "frontchannel_logout_enabled": false,
  "allowed_first_factors": ["password", "passkey", "magic_link", "enterprise"],
  "updated_at": "2026-10-05T09:30:00.123456Z"
}

Erreurs

Exemple

Activer les liens magiques par e-mail et désactiver les mots de passe :

curl -X PATCH https://api.eu.keenauth.com/v1/environment-settings \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -H 'If-Match: "0"' \
  -d '{"allowed_first_factors":["passkey","magic_link","social","enterprise"]}'

Paramètres de session et d'inscription :

curl -X PATCH https://api.eu.keenauth.com/v1/environment-settings \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -H 'If-Match: "0"' \
  -d '{"session":{"idle_timeout_s":3600},"signup":{"mode":"invite_only","email_domain_mode":"allowlist","email_domains":["example.com"]}}'