チケットをPOST - Auth0 Docs

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

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.Guardian.Enrollments.CreateTicketAsync(
            new CreateGuardianEnrollmentTicketRequestContent {
                UserId = "user_id"
            }
        );
    }

}

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.CreateGuardianEnrollmentTicketRequestContent{
        UserId: "user_id",
    }
    mgmt.Guardian.Enrollments.CreateTicket(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.guardian.types.CreateGuardianEnrollmentTicketRequestContent;

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

        client.guardian().enrollments().createTicket(
            CreateGuardianEnrollmentTicketRequestContent
                .builder()
                .userId("user_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Guardian\Enrollments\Requests\CreateGuardianEnrollmentTicketRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->guardian->enrollments->createTicket(
    new CreateGuardianEnrollmentTicketRequestContent([
        'userId' => 'user_id',
    ]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.enrollments.createTicket({
        userId: "user_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.enrollments.createTicket({
        userId: "user_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/guardian/enrollments/ticket \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "allow_multiple_enrollments": true,
  "email": "jsmith@example.com",
  "email_locale": "<string>",
  "send_mail": true
}
'

{
  "ticket_id": "u2x2-u2x2-u2x2-u2x2-u2x2-u2x2",
  "ticket_url": "<string>"
}

POST

https://{tenantDomain}/api/v2

guardian

enrollments

ticket

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

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.Guardian.Enrollments.CreateTicketAsync(
            new CreateGuardianEnrollmentTicketRequestContent {
                UserId = "user_id"
            }
        );
    }

}

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.CreateGuardianEnrollmentTicketRequestContent{
        UserId: "user_id",
    }
    mgmt.Guardian.Enrollments.CreateTicket(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.guardian.types.CreateGuardianEnrollmentTicketRequestContent;

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

        client.guardian().enrollments().createTicket(
            CreateGuardianEnrollmentTicketRequestContent
                .builder()
                .userId("user_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Guardian\Enrollments\Requests\CreateGuardianEnrollmentTicketRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->guardian->enrollments->createTicket(
    new CreateGuardianEnrollmentTicketRequestContent([
        'userId' => 'user_id',
    ]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.enrollments.createTicket({
        userId: "user_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.enrollments.createTicket({
        userId: "user_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/guardian/enrollments/ticket \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "allow_multiple_enrollments": true,
  "email": "jsmith@example.com",
  "email_locale": "<string>",
  "send_mail": true
}
'

{
  "ticket_id": "u2x2-u2x2-u2x2-u2x2-u2x2-u2x2",
  "ticket_url": "<string>"
}

承認

Authorization

string

header

必須

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

ヘッダー

auth0-custom-domain

string

この request で使用するカスタムドメイン

Required string length: 3 - 255

ボディ

user_id

string<user-id>

必須

enrollment ticket の user_id

allow_multiple_enrollments

boolean

省略可能。以前に MFA に登録済みのユーザーが、追加の認証要素を登録できるようにします。
注: このパラメーターは Universal Login でのみ使用でき、クラシックログインやカスタム MFA ページでは使用できません。

string<email>

enrollment メールの送信先となる代替メールアドレス。省略可能です。デフォルトでは、ユーザーの既定のアドレスにメールが送信されます

email_locale

string

省略可能。enrollment メールのロケールを指定します。send_email と併用します。

factor

enum<string>

任意。ユーザーが登録する認証要素を指定します。
注: このパラメーターはUniversal Loginでのみ使用でき、クラシックログインやカスタムMFAページでは使用できません。

利用可能なオプション:

push-notification,

phone,

email,

otp,

webauthn-roaming,

webauthn-platform

send_mail

boolean

ユーザーに enrollment を開始するためのメールを送信します

レスポンス

登録チケットが正常に作成されました。

ticket_id

string

デフォルト:u2x2-u2x2-u2x2-u2x2-u2x2-u2x2

enrollment を識別するために使用される ticket_id

ticket_url

string<url>

enrollment を開始するために使用できる URL