認証アプリの名前を変更

PATCH /fapi/v1/me/authenticators/{authenticator_id} · 環境のサインインホストから呼び出します

ユーザーが認証アプリの記録に付けた表示名を変更します。ユーザーの __Host-idp_session Cookie が必要です。Cookie がない、期限切れ、または取り消し済みの場合は、401 unauthenticated を返します。別のオリジンにあるファーストパーティのアプリは、代わりにフロント API アクセストークン(DPoP プルーフを付けた Authorization: DPoP <token>)を送信できます。詳しくは フロント API アクセストークン を参照してください。

リクエスト

ヘッダー:

ヘッダー 必須 説明
Idp-Client はい SDK の識別子です。
Origin はい 正確に https://<sign-in host> である必要があります。

ボディ:

{"label": "Work laptop"}

label は必須です。制御文字や方向制御文字を含めることはできません。

レスポンス

204 No Content を返します。

エラー

ステータス コード 発生条件
422 validation_failed label がない場合。
422 invalid_display_string label が表示名のルールに従っていない場合。
401 unauthenticated 有効なセッション Cookie がない場合。
403 origin_not_allowed Origin がない、または誤っている場合。
404 not_found このユーザーに該当する認証アプリがない場合。

例

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

個人データ

このエンドポイントは個人データ(認証情報)を扱います。KeenAuth API における個人データ では、保存される内容、保持期間、削除方法を説明しています。いかなるフィールドにも、特別な種類の個人データ(健康、生体情報、宗教、政治的意見、性的指向)を送信しないでください。