Créer un ticket d’inscription

Créez un ticket d’inscription à l’authentification multifacteur (MFA) et, au besoin, envoyez par courriel le ticket créé à un utilisateur donné. Les tickets d’inscription peuvent préciser le facteur avec lequel les utilisateurs doivent s’inscrire ou permettre aux utilisateurs qui utilisent déjà la MFA de s’inscrire à des facteurs supplémentaires.

POST https://{tenantDomain}/api/v2/guardian/enrollments/ticket

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &guardian.CreateGuardianEnrollmentTicketRequestContent{
        UserId: "user_id",
    }
    client.Guardian.Enrollments.CreateTicket(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        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": "[e-mail]",
  "email_locale": "<string>",
  "send_mail": true
}
'

import requests

url = "https://{tenantDomain}/api/v2/guardian/enrollments/ticket"

payload = {
    "user_id": "<string>",
    "allow_multiple_enrollments": True,
    "email": "[e-mail]",
    "email_locale": "<string>",
    "send_mail": True
}
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/guardian/enrollments/ticket",
  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([
    'user_id' => '<string>',
    'allow_multiple_enrollments' => true,
    'email' => '[e-mail]',
    'email_locale' => '<string>',
    'send_mail' => true
  ]),
  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/guardian/enrollments/ticket")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"allow_multiple_enrollments\": true,\n  \"email\": \"[e-mail]\",\n  \"email_locale\": \"<string>\",\n  \"send_mail\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/guardian/enrollments/ticket")

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  \"user_id\": \"<string>\",\n  \"allow_multiple_enrollments\": true,\n  \"email\": \"[e-mail]\",\n  \"email_locale\": \"<string>\",\n  \"send_mail\": true\n}"

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

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

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 demande

Required string length: 3 - 255

Corps

application/jsonapplication/x-www-form-urlencoded

user_id · string<user-id> · requis

user_id pour le ticket d’inscription

allow_multiple_enrollments · boolean

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

email · 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 le paramètre régional du courriel d’inscription. Utilisé avec send_email.

factor · enum<string>

Facultatif. Spécifie le facteur avec lequel l’utilisateur doit s’inscrire.
Remarque : ce paramètre peut être utilisé uniquement 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

200

application/json

Le ticket d’inscription a été 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