認証メソッド ID を指定して認証メソッドを部分更新

指定したユーザーの、指定したIDの認証方法を変更します。詳細については、Manage Authentication Methods with Management APIを参照してください。

PATCH https://{tenantDomain}/api/v2/users/{id}/authentication-methods/{authentication_method_id}

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    users "github.com/auth0/go-auth0/management/management/users"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &users.UpdateUserAuthenticationMethodRequestContent{}
    client.Users.AuthenticationMethods.Update(
        context.TODO(),
        "id",
        "authentication_method_id",
        request,
    )
}

200

{
  "aaguid": "<string>",
  "authentication_methods": [
    {
      "id": "<string>"
    }
  ],
  "confirmed": true,
  "created_at": "2023-11-07T05:31:56Z",
  "email": "<string>",
  "id": "<string>",
  "key_id": "<string>",
  "name": "<string>",
  "phone_number": "<string>",
  "public_key": "<string>",
  "relying_party_identifier": "<string>",
  "totp_secret": "<string>"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string · 必須

対象ユーザーのID。

authentication_method_id · string · 必須

更新する認証方法のID。

ボディ

application/jsonapplication/x-www-form-urlencoded

name · string

認証方法を識別するための、人が判読しやすいラベル。

preferred_authentication_method · enum<string>

推奨される電話認証方法

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

レスポンス

200

application/json

認証方法が更新されました。

正常に作成された認証方法。

type · enum<string> · 必須

利用可能なオプション: phone, email, totp, webauthn-roaming

aaguid · string

パスキーの認証方法にのみ適用されます。Authenticator Attestation Globally Unique Identifier。

authentication_methods · object[]

Show child attributes

confirmed · boolean

この認証方法が確認済みかどうか。

created_at · string<date-time>

認証方法の作成日

email · string

メールアドレスの認証方法にのみ適用されます。確認メッセージの送信に使用されるメールアドレス。

id · string<authenticator-id>

新しく作成された認証方法の ID（アプリケーションによって自動生成）

key_id · string

WebAuthn の認証方法にのみ適用されます。認証情報の id。

name · string

認証方法を識別するための、人が判読しやすいラベル。

phone_number · string

電話の認証方法にのみ適用されます。テキストメッセージおよび音声で確認コードを送信するために使用される宛先電話番号。

Required string length: 2 - 30

preferred_authentication_method · enum<string>

電話の認証方法にのみ適用されます。優先する通信方法です。

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

public_key · string

WebAuthn の認証方法にのみ適用されます。公開鍵。

relying_party_identifier · string

WebAuthn の認証方法にのみ適用されます。Relying Party 識別子。

totp_secret · string

TOTP の生成に使用する Base32 エンコード済みシークレット