メインコンテンツへスキップ
PATCH
https://{host}/me/v1
/
authentication-methods
/
{authentication_method_id}
ID を指定して認証方法の詳細を更新
curl --request PATCH \
  --url https://{host}/me/v1/authentication-methods/{authentication_method_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "usage": [],
  "identity_user_id": "<string>",
  "type": "password",
  "last_password_reset": "2023-11-07T05:31:56Z"
}

承認

Authorization
string
header
必須

Bearer トークンと DPoP トークンは、API の設定に応じてサポートされます

パスパラメータ

authentication_method_id
string
必須

認証方法 ID。この値は、認証方法の作成時に返される Location ヘッダーの一部です。変更を加えず、そのまま使用してください。

ボディ

application/json

認証方法を更新するためのリクエスト内容

name
string

認証方法のフレンドリ名

preferred_authentication_method
enum<string>

優先する認証方法(電話番号の認証要素用)

利用可能なオプション:
sms,
voice

レスポンス

認証方法を正常に更新しました

created_at
string<date-time>
必須

認証方法が作成された日時

id
string
必須

認証方法の一意の識別子

usage
enum<string>[]
必須

プライマリおよび/またはセカンダリの認証要素

認証要素の用途タイプ

利用可能なオプション:
primary,
secondary
identity_user_id
string
必須

認証方法に関連付けられたユーザーアイデンティティの ID

type
string
デフォルト:password
必須

認証方法のタイプ(認証要素)

Allowed value: "password"
last_password_reset
string<date-time>

最後にパスワードリセットが行われた日付