認証メソッドを作成

認証方法を作成します。このエンドポイントを介して作成された認証方法は自動的に確認済みとして扱われるため、検証はあらかじめ完了している必要があります。

POST 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"
    users "github.com/auth0/go-auth0/management/management/users"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &users.CreateUserAuthenticationMethodRequestContent{
        Type: management.CreatedUserAuthenticationMethodTypeEnumPhone,
    }
    client.Users.AuthenticationMethods.Create(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.authenticationMethods.create("id", {
        type: "phone",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.authenticationMethods.create("id", {
        type: "phone",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/users/{id}/authentication-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aaguid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credential_backed_up": true,
  "email": "<string>",
  "identity_user_id": "<string>",
  "key_id": "<string>",
  "name": "<string>",
  "phone_number": "<string>",
  "public_key": "<string>",
  "relying_party_identifier": "<string>",
  "totp_secret": "<string>",
  "transports": [
    "<string>"
  ],
  "user_agent": "<string>",
  "user_handle": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/users/{id}/authentication-methods"

payload = {
    "aaguid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "credential_backed_up": True,
    "email": "<string>",
    "identity_user_id": "<string>",
    "key_id": "<string>",
    "name": "<string>",
    "phone_number": "<string>",
    "public_key": "<string>",
    "relying_party_identifier": "<string>",
    "totp_secret": "<string>",
    "transports": ["<string>"],
    "user_agent": "<string>",
    "user_handle": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/users/{id}/authentication-methods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'aaguid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'credential_backed_up' => true,
    'email' => '<string>',
    'identity_user_id' => '<string>',
    'key_id' => '<string>',
    'name' => '<string>',
    'phone_number' => '<string>',
    'public_key' => '<string>',
    'relying_party_identifier' => '<string>',
    'totp_secret' => '<string>',
    'transports' => [
        '<string>'
    ],
    'user_agent' => '<string>',
    'user_handle' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/users/{id}/authentication-methods")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"aaguid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"credential_backed_up\": true,\n  \"email\": \"<string>\",\n  \"identity_user_id\": \"<string>\",\n  \"key_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"public_key\": \"<string>\",\n  \"relying_party_identifier\": \"<string>\",\n  \"totp_secret\": \"<string>\",\n  \"transports\": [\n    \"<string>\"\n  ],\n  \"user_agent\": \"<string>\",\n  \"user_handle\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/users/{id}/authentication-methods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"aaguid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"credential_backed_up\": true,\n  \"email\": \"<string>\",\n  \"identity_user_id\": \"<string>\",\n  \"key_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"public_key\": \"<string>\",\n  \"relying_party_identifier\": \"<string>\",\n  \"totp_secret\": \"<string>\",\n  \"transports\": [\n    \"<string>\"\n  ],\n  \"user_agent\": \"<string>\",\n  \"user_handle\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "aaguid": "<string>",
  "authentication_methods": [
    {
      "id": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "credential_backed_up": true,
  "email": "<string>",
  "id": "<string>",
  "identity_user_id": "<string>",
  "key_id": "<string>",
  "name": "<string>",
  "phone_number": "<string>",
  "public_key": "<string>",
  "relying_party_identifier": "<string>",
  "totp_secret": "<string>",
  "transports": [
    "<string>"
  ],
  "user_agent": "<string>",
  "user_handle": "<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, webauthn-roaming, passkey

aaguid · string<uuid>

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

credential_backed_up · boolean

パスキーにのみ適用されます。認証情報がバックアップされたかどうかです。

credential_device_type · enum<string>

パスキーにのみ適用されます。backup eligibility で定義される、認証情報が保存されているデバイスの種類です。"single_device" 認証情報はバックアップして別のデバイスに同期できません。"multi_device" 認証情報は、エンドユーザーが有効にしている場合にバックアップできます。

利用可能なオプション: single_device, multi_device

email · string

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

identity_user_id · string

パスキーにのみ適用されます。認証方法に関連付けられたユーザーアイデンティティの 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/パスキーの認証方法にのみ適用されます。base64 エンコードされた公開鍵です。

relying_party_identifier · string<hostname>

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

totp_secret · string

TOTP 生成用の Base32 エンコードされたシークレット。

transports · string[]

パスキーにのみ適用されます。クライアントが認証要素と通信するために使用するトランスポートです。

user_agent · string

パスキーにのみ適用されます。パスキーの作成に使用されたブラウザーのユーザーエージェントです。

user_handle · string

パスキーにのみ適用されます。ユーザーアイデンティティのユーザーハンドルです。

レスポンス

201

application/json

認証方法が作成されました。

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

type · enum<string> · 必須

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

aaguid · string

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

authentication_methods · object[]

Show child attributes

created_at · string<date-time>

認証方法の作成日

credential_backed_up · boolean

パスキーにのみ適用されます。認証情報がバックアップされたかどうかです。

credential_device_type · enum<string>

パスキーにのみ適用されます。backup eligibility で定義される、認証情報が保存されているデバイスの種類です。"single_device" 認証情報はバックアップして別のデバイスに同期できません。"multi_device" 認証情報は、エンドユーザーが有効にしている場合にバックアップできます。

利用可能なオプション: single_device, multi_device

email · string

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

id · string<authenticator-id>

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

identity_user_id · string

パスキーにのみ適用されます。認証方法に関連付けられたユーザーアイデンティティの 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 エンコードされたシークレット

transports · string[]

パスキーにのみ適用されます。クライアントが認証要素と通信するために使用するトランスポートです。

user_agent · string

パスキーにのみ適用されます。パスキーの作成に使用されたブラウザーのユーザーエージェントです。

user_handle · string

パスキーにのみ適用されます。ユーザーアイデンティティのユーザーハンドルです。