Aller au contenu principal

generateCode

Envoie un code à usage unique à l'utilisateur.

Cette fonctionnalité ne fonctionne que si elle est activée dans le panneau d'administration (ouvre dans un nouvel onglet).

Description​

Demande à OneEntry de générer un code à usage unique et de l'envoyer à l'utilisateur via le canal de notification configuré dans le panneau d'administration. Utilisez-la pour renvoyer un code d'activation ou pour lancer une réinitialisation de mot de passe. Se résout en un objet vide {} en cas de succès.

eventIdentifier doit être le marqueur d'un événement dont le type de formulaire est Send code dans le module Events, sinon l'API renvoie 404. Demander un nouveau code trop tôt après le précédent renvoie 429.

.generateCode(

, ,

);

Schéma des paramètres​

Schéma

marker(required): string
Marqueur du fournisseur d'authentification.
exemple : "email"

userIdentifier(required): string
Identifiant (login) de l'utilisateur, par exemple une adresse e-mail.
exemple : "john@example.com"

eventIdentifier(required): string
Marqueur de l'événement pour lequel le code est généré.
exemple : "user_registration"

Exemples​

Exemple minimal​

const response = await AuthProvider.generateCode('email', 'john@example.com', 'user_registration');