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,
    )
}

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