Créer un ticket de vérification du courriel

Créer un ticket de vérification du courriel pour un utilisateur donné. Un ticket de vérification du courriel est une URL générée que l’utilisateur peut utiliser pour vérifier son adresse de courriel.

POST https://{tenantDomain}/api/v2/tickets/email-verification

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.VerifyEmailTicketRequestContent{
        UserId: "user_id",
    }
    client.Tickets.VerifyEmail(
        context.TODO(),
        request,
    )
}

201

{
  "ticket": "https://login.auth0.com/lo/verify_email?client_id=nsaPS2p3cargoFy82WT7betaOPOt3qSh&tenant=mdocs&bewit=bmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPdDNxU2hcMTQzMDY2MjE4MVxuRTcxM0RSeUNlbEpzUUJmaFVaS3A1NEdJbWFzSUZMYzRTdEFtY2NMMXhZPVx7ImVtYWloojoiZGFtaWtww2NoQGhvdG1haWwuY29tIiwidGVuYW50IjoiZHNjaGVua2tjwWFuIiwiY2xpZW50X2lkIjoibmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPiiqxU2giLCJjb25uZWN0aW9uIjoiRGFtaWmsdiwicmVzdWx0VXJsIjoiIn0"
}

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 requête

Required string length: 3 - 255

Corps

application/jsonapplication/x-www-form-urlencoded

user_id · string<user-id> · requis

user_id pour lequel le ticket doit être créé.

client_id · string<client-id> · défaut: DaM8bokEXBWrTUFCiJjWn50jei6ardyX

ID du client (application). S’il est fourni pour des locataires utilisant l’expérience New Universal Login, le modèle de courriel et l’interface utilisateur affichent les détails de l’application, et l’utilisateur est invité à être redirigé vers la route de connexion par défaut de l’application une fois le ticket utilisé. client_id est requis pour utiliser le déclencheur Password Reset Post Challenge.

identity · object

Ce paramètre doit être fourni pour vérifier les identités de courriel principales des connexions sociales, d’entreprise et Passwordless. Il est également nécessaire pour vérifier les identités secondaires.

Show child attributes

includeEmailInRedirect · boolean

Indique s’il faut inclure l’adresse de courriel dans le returnUrl dans le cadre de reset_email (true), ou non (false).

organization_id · string<organization-id> · défaut: org_2eondWoxcMIpaLQc

(Facultatif) ID de l’Organisation – l’ID de l’Organisation. S’il est fourni, les paramètres de l’organisation seront mis à la disposition du modèle de courriel et l’image de marque de l’organisation sera appliquée à l’invite. De plus, le lien de redirection dans l’invite comprendra les paramètres de requête organization_id et organization_name.

result_url · string<url> · défaut: http://myapp.com/callback

URL vers laquelle l’utilisateur sera redirigé dans l’expérience Universal Login classique une fois le ticket utilisé. Ne peut pas être spécifiée si client_id ou organization_id est utilisé.

ttl_sec · integer

Nombre de secondes pendant lesquelles le ticket est valide avant d’expirer. S’il n’est pas précisé ou s’il est défini à 0, cette valeur est de 432000 secondes (5 jours) par défaut.

Plage requise: x >= 0

Réponse

201

application/json

Ticket créé avec succès.

ticket · string<url> · défaut: https://login.auth0.com/lo/verify_email?client_id=nsaPS2p3cargoFy82WT7betaOPOt3qSh&tenant=mdocs&bewit=bmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPdDNxU2hcMTQzMDY2MjE4MVxuRTcxM0RSeUNlbEpzUUJmaFVaS3A1NEdJbWFzSUZMYzRTdEFtY2NMMXhZPVx7ImVtYWloojoiZGFtaWtww2NoQGhvdG1haWwuY29tIiwidGVuYW50IjoiZHNjaGVua2tjwWFuIiwiY2xpZW50X2lkIjoibmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPiiqxU2giLCJjb25uZWN0aW9uIjoiRGFtaWmsdiwicmVzdWx0VXJsIjoiIn0 · requis

URL représentant le ticket.