Passer au contenu principal
POST
https://{tenantDomain}/api/v2
/
tickets
/
password-change
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.ChangePasswordTicketRequestContent{}
    client.Tickets.ChangePassword(
        context.TODO(),
        request,
    )
}
{
  "ticket": "https://login.auth0.com/lo/reset?client_id=nsaPS2p3cargoFy82WT7betaOPOt3qSh&tenant=mdocs&bewit=bmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPdDNxU2hcMTQzMDY2MjE4MVxuRTcxM0RSeUNlbEpzUUJmaFVaS3A1NEdJbWFzSUZMYzRTdEFtY2NMMXhZPVx7ImVtYWloojoiZGFtaWtww2NoQGhvdG1haWwuY29tIiwidGVuYW50IjoiZHNjaGVua2tjwWFuIiwiY2xpZW50X2lkIjoibmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPiiqxU2giLCJjb25uZWN0aW9uIjoiRGFtaWmsdiwicmVzdWx0VXJsIjoiIn0"
}

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

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

ID de l’application. S’il est fourni pour des locataires qui utilisent l’expérience New Universal Login, le modèle de courriel et l’interface 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 après l’utilisation du ticket. client_id est requis pour utiliser le déclencheur Password Reset Post Challenge.

connection_id
string
défaut:con_0000000000000001

ID de la connexion. S’il est fourni, permet de préciser l’utilisateur à l’aide du courriel plutôt que du user_id. Si vous définissez cette valeur, vous devez aussi envoyer le paramètre email. Vous ne pouvez pas envoyer user_id lorsque vous spécifiez un connection_id.

Pattern: ^con_[A-Za-z0-9]{16}$
email
string<email>

Adresse de courriel de l’utilisateur pour lequel les tickets doivent être créés. Nécessite le paramètre connection_id. Ne peut pas être spécifiée si vous utilisez user_id.

identity
object
EA

L’identité de l’utilisateur. Si vous définissez cette valeur, vous devez aussi envoyer le paramètre user_id.

includeEmailInRedirect
boolean

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

mark_email_as_verified
boolean
défaut:false

Indique s’il faut définir l’attribut email_verified à true (true) ou ne pas le mettre à jour (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 vous utilisez organization_id. Peut être spécifiée avec client_id lorsque le locataire a activé une page personnalisée de réinitialisation du mot de passe et qu’une Action password-reset-post-challenge est associée.

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
user_id
string<user-id>

user_id de l’utilisateur pour lequel le ticket doit être créé.

Réponse

Ticket créé avec succès.

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

URL représentant le ticket.