Renommer un authentificateur

PATCH /fapi/v1/me/authenticators/{authenticator_id} · appelé depuis l'hôte de connexion de l'environnement

Modifie le nom d'affichage que l'utilisateur a donné à un enregistrement d'authentificateur. Nécessite le cookie __Host-idp_session de l'utilisateur authentifié ; si le cookie est absent, expiré ou révoqué, renvoie 401 unauthenticated. Une application de première partie sur une autre origine peut envoyer à la place son jeton d'accès à l'API front (Authorization: DPoP <token> avec une preuve DPoP ; voir Jeton d'accès à l'API front).

Requête

En-têtes :

En-tête Obligatoire Description
Idp-Client oui Identifiant du SDK.
Origin oui Doit être exactement https://<hôte de connexion>.

Corps :

{"label": "Work laptop"}

label est obligatoire ; il ne peut pas contenir de caractères de contrôle ni de marqueurs directionnels.

Réponse

204 No Content.

Erreurs

Statut Code Quand
422 validation_failed label est absent.
422 invalid_display_string label ne respecte pas les règles relatives aux noms d'affichage.
401 unauthenticated Aucun cookie de session valide.
403 origin_not_allowed Origin est absent ou incorrect.
404 not_found Aucun authentificateur de ce type pour cet utilisateur.

Exemple

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

Données personnelles

Ce point de terminaison traite des données personnelles : des identifiants. Données personnelles dans les API KeenAuth décrit ce qui est stocké, pendant combien de temps les données sont conservées et comment elles sont supprimées. Ne transmettez dans aucun champ de catégories particulières de données personnelles (santé, données biométriques, religion, opinions politiques, orientation sexuelle).