Ein Authentifizierungsmittel umbenennen

PATCH /fapi/v1/me/authenticators/{authenticator_id} · wird vom Anmelde-Host der Umgebung aufgerufen

Ändert den Anzeigenamen, den der Benutzer einem Eintrag für ein Authentifizierungsmittel gegeben hat. Erforderlich ist das Cookie __Host-idp_session des authentifizierten Benutzers; fehlt das Cookie, ist es abgelaufen oder widerrufen, wird 401 unauthenticated zurückgegeben. Eine First-Party-Anwendung auf einem anderen Origin kann stattdessen ihr Zugriffstoken für die Front API senden (Authorization: DPoP <token> mit einem DPoP-Proof; siehe Zugriffstoken für die Front API).

Anfrage

Header:

Header Pflicht Beschreibung
Idp-Client ja SDK-Kennung.
Origin ja Muss exakt https://<sign-in host> sein.

Body:

{"label": "Work laptop"}

label ist erforderlich; er darf keine Steuerzeichen oder Richtungsmarkierungen enthalten.

Antwort

204 No Content.

Fehler

Status Code Wann
422 validation_failed label fehlt.
422 invalid_display_string label entspricht nicht den Regeln für Anzeigenamen.
401 unauthenticated Kein gültiges Sitzungs-Cookie.
403 origin_not_allowed Origin fehlt oder ist falsch.
404 not_found Für diesen Benutzer existiert kein solches Authentifizierungsmittel.

Beispiel

curl -X PATCH https://example.keenauth.app/fapi/v1/me/authenticators/cred_01j9zzzzzzzzzzzzzzzzzzzzzz \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -H "Origin: https://example.keenauth.app" \
  -H "Content-Type: application/json" \
  -d '{"label": "Work laptop"}' \
  -b cookies.txt

Personenbezogene Daten

Dieser Endpunkt verarbeitet personenbezogene Daten: Berechtigungsnachweise. Personenbezogene Daten in den KeenAuth-APIs beschreibt, was gespeichert wird, wie lange es aufbewahrt wird und wie es gelöscht wird. Übermitteln Sie in keinem Feld besondere Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung).