認証方法をPOST - Auth0 Docs

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Users;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.AuthenticationMethods.CreateAsync(
            id: "id",
            request: new CreateUserAuthenticationMethodRequestContent {
                Type = CreatedUserAuthenticationMethodTypeEnum.Phone
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateUserAuthenticationMethodRequestContent{
        Type: management.CreatedUserAuthenticationMethodTypeEnumPhone,
    }
    mgmt.Users.AuthenticationMethods.Create(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreatedUserAuthenticationMethodTypeEnum;
import com.auth0.client.mgmt.users.types.CreateUserAuthenticationMethodRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.users().authenticationMethods().create(
            "id",
            CreateUserAuthenticationMethodRequestContent
                .builder()
                .type(CreatedUserAuthenticationMethodTypeEnum.PHONE)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\AuthenticationMethods\Requests\CreateUserAuthenticationMethodRequestContent;
use Auth0\SDK\API\Management\Types\CreatedUserAuthenticationMethodTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->authenticationMethods->create(
    'id',
    new CreateUserAuthenticationMethodRequestContent([
        'type' => CreatedUserAuthenticationMethodTypeEnum::Phone->value,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.authentication_methods.create(
    id="id",
    type="phone",
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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>"
}
'

{
  "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>"
}

POST

https://{tenantDomain}/api/v2

users

{id}

authentication-methods

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Users;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.AuthenticationMethods.CreateAsync(
            id: "id",
            request: new CreateUserAuthenticationMethodRequestContent {
                Type = CreatedUserAuthenticationMethodTypeEnum.Phone
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateUserAuthenticationMethodRequestContent{
        Type: management.CreatedUserAuthenticationMethodTypeEnumPhone,
    }
    mgmt.Users.AuthenticationMethods.Create(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreatedUserAuthenticationMethodTypeEnum;
import com.auth0.client.mgmt.users.types.CreateUserAuthenticationMethodRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.users().authenticationMethods().create(
            "id",
            CreateUserAuthenticationMethodRequestContent
                .builder()
                .type(CreatedUserAuthenticationMethodTypeEnum.PHONE)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\AuthenticationMethods\Requests\CreateUserAuthenticationMethodRequestContent;
use Auth0\SDK\API\Management\Types\CreatedUserAuthenticationMethodTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->authenticationMethods->create(
    'id',
    new CreateUserAuthenticationMethodRequestContent([
        'type' => CreatedUserAuthenticationMethodTypeEnum::Phone->value,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.authentication_methods.create(
    id="id",
    type="phone",
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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>"
}
'

{
  "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>"
}

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

新しい認証方法の割り当て先となるユーザーの ID。

ボディ

type

enum<string>

必須

利用可能なオプション:

phone,

email,

totp,

webauthn-roaming,

passkey

aaguid

string<uuid>

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

credential_backed_up

boolean

パスキーにのみ適用されます。クレデンシャルがバックアップ済みかどうか。

credential_device_type

enum<string>

パスキーにのみ適用されます。backup eligibility で定義される、クレデンシャルが保存されるデバイスの種類です。"single_device" クレデンシャルはバックアップしたり別のデバイスに同期したりできません。"multi_device" クレデンシャルは、end-user が有効にしている場合にバックアップできます。

利用可能なオプション:

single_device,

multi_device

string

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

identity_user_id

string

パスキーにのみ適用されます。認証方法にリンクされたユーザーアイデンティティの ID です。

key_id

string

webauthn/パスキー認証方法にのみ適用されます。クレデンシャルのID。

name

string

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

phone_number

string

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

Required string length: 2 - 30

preferred_authentication_method

enum<string>

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

利用可能なオプション:

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

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

レスポンス

認証方法を作成しました。

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

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 がバックアップされたかどうかです。

credential_device_type

enum<string>

利用可能なオプション:

single_device,

multi_device

string

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

string<authenticator-id>

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

identity_user_id

string

パスキーにのみ適用されます。認証方法にリンクされたユーザーアイデンティティの ID です。

key_id

string

webauthn 認証器にのみ適用されます。credential の 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

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