Alle zweiten Faktoren eines Benutzers zurücksetzen

POST /v1/users/{user_id}/authenticators:reset · Berechtigung user-credentials:write

Widerruft alle zweiten Faktoren des Benutzers und löscht die Wiederherstellungscodes; der Benutzer registriert beim nächsten Anmelden erneut einen Faktor. include_passkeys ist standardmäßig true; bei false bleiben Passkeys (einschließlich solcher mit Rolle both) erhalten. Die Schritte werden nach bestem Bemühen ausgeführt und können wiederholt werden; ein Fehler bei der Benachrichtigung lässt den Aufruf nicht fehlschlagen (notified). Die Antwort enthält Anzahlen, niemals Codes oder Geheimnisse. Senden Sie einen Idempotency-Key-Header, damit Wiederholungen sicher sind.

Anfrage

Parameter In Pflicht Beschreibung
user_id path ja Benutzer-ID, Präfix usr_.

Optionaler Body:

Feld Typ Pflicht Beschreibung
include_passkeys boolean nein true standardmäßig: Passkeys werden ebenfalls widerrufen. Bei false bleiben Passkeys (einschließlich Rolle both) erhalten.
locale string nein BCP-47-Sprachkennzeichnung der Benachrichtigung, zum Beispiel tr. Standardmäßig die Sprache des Benutzers oder der Umgebung.

Antwort

200 OK. Der Body zählt, was ausgeführt wurde.

{
  "revoked_authenticators": 3,
  "recovery_codes_deleted": true,
  "notified": true
}

Fehler

Jeder Fehler ist ein application/problem+json-Body mit einem stabilen code.

HTTP code Wann
400 malformed_request, unknown_field Der Body ist kein gültiges JSON oder enthält ein unbekanntes Feld.
415 unsupported_media_type Ein Body wurde ohne Content-Type: application/json gesendet.
422 validation_failed locale ist kein gültiges BCP-47-Sprachkennzeichen, oder ein Feld hat den falschen Typ.
404 not_found Der Benutzer existiert nicht in dieser Umgebung (oder die ID ist fehlerhaft).
401 unauthenticated Der API-Schlüssel fehlt, ist ungültig oder wurde widerrufen.
403 insufficient_permissions Dem Schlüssel fehlt die Berechtigung user-credentials:write.
429 rate_limited Das Ratenlimit wurde überschritten; beachten Sie Retry-After.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar; versuchen Sie es später erneut.

Beispiel

curl -X POST https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p/authenticators:reset \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"include_passkeys": false, "locale": "en"}'

Personenbezogene Daten

Dieser Endpunkt verarbeitet personenbezogene Daten: Zugangsdaten. Personenbezogene Daten in den KeenAuth-APIs beschreibt, welche Daten gespeichert werden, wie lange sie aufbewahrt und wie sie gelöscht werden. Senden Sie in keinem Feld besondere Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung).