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

Autorisations

Authorization

string

header

requis

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

En-têtes

auth0-custom-domain

string

Domaine personnalisé à utiliser pour cette requête

Required string length: 3 - 255

Corps

user_id

string<user-id>

requis

user_id du ticket d’inscription

allow_multiple_enrollments

boolean

Facultatif. Permet à un utilisateur déjà inscrit à l’AMF d’inscrire des facteurs supplémentaires.
Remarque : ce paramètre ne peut être utilisé qu’avec Universal Login; il ne peut pas être utilisé avec Classic Login ni avec des pages d’AMF personnalisées.

string<email>

courriel secondaire auquel le courriel d’inscription sera envoyé. Facultatif - par défaut, le courriel sera envoyé à l’adresse par défaut de l’utilisateur

email_locale

string

Facultatif. Précisez la locale du courriel d’inscription. Utilisé avec send_email.

factor

enum<string>

Facultatif. Indique le facteur avec lequel l’utilisateur doit s’enrôler.
Remarque : ce paramètre ne peut être utilisé qu’avec Universal Login; il ne peut pas être utilisé avec Classic Login ni avec des pages MFA personnalisées.

Options disponibles:

push-notification,

phone,

email,

otp,

webauthn-roaming,

webauthn-platform

send_mail

boolean

Envoyer un courriel à l’utilisateur pour lancer l’inscription

Réponse

Ticket d’inscription créé avec succès.

ticket_id

string

défaut:u2x2-u2x2-u2x2-u2x2-u2x2-u2x2

Le ticket_id utilisé pour identifier l’inscription

ticket_url

string<url>

L’URL que vous pouvez utiliser pour lancer l’inscription