認証方式を設定

指定したユーザーの認証方法を、指定された値で置き換えます。

注: この操作で指定した認証方法は、既存の方法に追加されません。代わりに、渡された方法によってユーザーの既存の設定が上書きされます。

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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := []*management.SetUserAuthenticationMethods{
        &management.SetUserAuthenticationMethods{
            Type: management.AuthenticationTypeEnumPhone,
        },
    }
    client.Users.AuthenticationMethods.Set(
        context.TODO(),
        "id",
        request,
    )
}

200

[
  {
    "aaguid": "<string>",
    "authentication_methods": [
      {
        "id": "<string>"
      }
    ],
    "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。

ボディ

application/jsonapplication/x-www-form-urlencoded

type · enum<string> · 必須

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

email · string

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

Minimum string length: 1

name · string

認証方法を識別するためのわかりやすいラベル。

Required string length: 1 - 20

phone_number · string

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

Required string length: 2 - 30

preferred_authentication_method · enum<string>

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

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

totp_secret · string

totp の認証方法にのみ適用されます。TOTP 生成用の base32 エンコードされたシークレットです。

Minimum string length: 1

レスポンス

200

application/json

すべての認証方法が正常に更新されました。

type · enum<string> · 必須

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

aaguid · string

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

authentication_methods · object[]

Show child attributes

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 エンコード済みのシークレット