認証方法を設定

using Auth0.ManagementApi;
using System.Threading.Tasks;
using System.Collections.Generic;

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.SetAsync(
            id: "id",
            request: new List<SetUserAuthenticationMethods>(){
                new SetUserAuthenticationMethods {
                    Type = AuthenticationTypeEnum.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.SetUserAuthenticationMethods{
        &management.SetUserAuthenticationMethods{
            Type: management.AuthenticationTypeEnumPhone,
        },
    }
    mgmt.Users.AuthenticationMethods.Set(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.AuthenticationTypeEnum;
import com.auth0.client.mgmt.types.SetUserAuthenticationMethods;
import java.util.Arrays;

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

        client.users().authenticationMethods().set(
            "id",
            Arrays.asList(
                SetUserAuthenticationMethods
                    .builder()
                    .type(AuthenticationTypeEnum.PHONE)
                    .build()
            )
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Types\SetUserAuthenticationMethods;
use Auth0\SDK\API\Management\Types\AuthenticationTypeEnum;

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

from auth0.management import ManagementClient, SetUserAuthenticationMethods

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

client.users.authentication_methods.set(
    id="id",
    request=[
        SetUserAuthenticationMethods(
            type="phone",
        )
    ],
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.authentication_methods.set(
  id: "id",
  request: [{
    type: "phone"
  }]
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request PUT \
  --url https://{tenantDomain}/api/v2/users/{id}/authentication-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "email": "<string>",
    "name": "<string>",
    "phone_number": "<string>",
    "totp_secret": "<string>"
  }
]
'

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

PUT

https://{tenantDomain}/api/v2

users

{id}

authentication-methods

using Auth0.ManagementApi;
using System.Threading.Tasks;
using System.Collections.Generic;

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.SetAsync(
            id: "id",
            request: new List<SetUserAuthenticationMethods>(){
                new SetUserAuthenticationMethods {
                    Type = AuthenticationTypeEnum.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.SetUserAuthenticationMethods{
        &management.SetUserAuthenticationMethods{
            Type: management.AuthenticationTypeEnumPhone,
        },
    }
    mgmt.Users.AuthenticationMethods.Set(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.AuthenticationTypeEnum;
import com.auth0.client.mgmt.types.SetUserAuthenticationMethods;
import java.util.Arrays;

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

        client.users().authenticationMethods().set(
            "id",
            Arrays.asList(
                SetUserAuthenticationMethods
                    .builder()
                    .type(AuthenticationTypeEnum.PHONE)
                    .build()
            )
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Types\SetUserAuthenticationMethods;
use Auth0\SDK\API\Management\Types\AuthenticationTypeEnum;

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

from auth0.management import ManagementClient, SetUserAuthenticationMethods

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

client.users.authentication_methods.set(
    id="id",
    request=[
        SetUserAuthenticationMethods(
            type="phone",
        )
    ],
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.authentication_methods.set(
  id: "id",
  request: [{
    type: "phone"
  }]
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request PUT \
  --url https://{tenantDomain}/api/v2/users/{id}/authentication-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "email": "<string>",
    "name": "<string>",
    "phone_number": "<string>",
    "totp_secret": "<string>"
  }
]
'

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

承認

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

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>

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

利用可能なオプション:

voice,

sms

totp_secret

string

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

Minimum string length: 1

レスポンス

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

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>

認証方法の作成日時

string

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

string<authenticator-id>

新しく作成された認証方法の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認証器にのみ適用されます。リライングパーティ識別子。

totp_secret

string

TOTP生成用のBase32エンコードされたSecret