api.access
Modifiez l’accès de l’utilisateur qui tente de réinitialiser son mot de passe.
api.access.deny(reason)
Marquez la tentative actuelle de réinitialisation de mot de passe comme rejetée. L’utilisateur final ne pourra alors pas terminer
le processus de réinitialisation de mot de passe. Cela n’ANNULERA PAS les autres effets secondaires liés à l’utilisateur
demandés par cette Action. Le processus de réinitialisation de mot de passe s’arrêtera immédiatement après
l’exécution de cette action, et aucune autre Action ne sera exécutée.
Paramètres
api.authentication
Demande de modifier l’état d’authentification de la session de l’utilisateur actuel.
api.authentication.challengeWith(factor, options)
Demande une vérification multifacteur à l’aide du facteur fourni et de facteurs supplémentaires facultatifs.
Lorsqu’une vérification multifacteur est demandée, les Actions suivantes ne s’exécutent pas tant que l’utilisateur n’a pas répondu à cette vérification. Un utilisateur aura répondu à la vérification dans l’une ou l’autre des situations suivantes :
- Il répond avec succès à la vérification associée au facteur par défaut.
- Il répond avec succès à la vérification associée à l’un des facteurs facultatifs décrits dans
additionalFactors.
Cette méthode affiche un écran de vérification de facteur si l’utilisateur n’a pas déjà satisfait aux exigences de la vérification. Si des
additionalFactors sont fournis, l’utilisateur peut choisir un autre facteur.api.authentication.challengeWithAny(factors)
Demande une vérification d’authentification multifacteur à l’aide de l’un des facteurs fournis (en affichant d’abord un écran de sélection des facteurs).
Lorsqu’une vérification multifacteur est demandée, les Actions suivantes ne sont pas exécutées tant que l’utilisateur n’y a pas répondu. Un utilisateur aura satisfait à la vérification dans l’une ou l’autre des situations suivantes :
- Il termine avec succès la vérification associée à l’un des facteurs.
Cette méthode affiche l’écran de sélection des facteurs si l’utilisateur n’a pas déjà satisfait aux exigences de la vérification. Si un facteur est privilégié, il est préférable d’utiliser la méthode
api.authentication.challengeWith(). L’écran de sélection des facteurs ne s’affiche pas si un seul facteur est transmis ou valide.api.redirect
Configurez et lancez des redirections externes.
api.redirect.encodeToken(options)
Crée un jeton de session pouvant être utilisé comme paramètre de chaîne de requête pour la cible de redirection (au moyen de sendUserTo)
et contenant des données dont l’authenticité doit pouvoir être vérifiée par le point de terminaison cible. Le point de terminaison cible
peut vérifier l’authenticité et l’intégrité des données en vérifiant la signature du JWT
à l’aide d’un secret partagé.
Le secret partagé doit être stocké dans un secret de l’Action et est accessible à l’emplacement
event.secrets['<secret_name>'].
Paramètres
api.redirect.sendUserTo(url, options)
Déclenche une redirection du navigateur vers l’url cible dans le pipeline de réinitialisation du mot de passe, immédiatement après l’exécution de cette action. La méthode d’assistance createUrl permet de simplifier l’encodage de données sous forme de paramètre de requête dans l’url cible, afin que le point de terminaison cible puisse en vérifier l’authenticité et l’intégrité.
Paramètres
api.redirect.validateToken(options)
Récupère les données encodées dans un jeton JWT transmis au point de terminaison /continue, tout en vérifiant
l’authenticité et l’intégrité de ces données.
Paramètres
api.cache
Modifiez le cache.
api.cache.delete(key)
Supprime, s’il existe, l’enregistrement décrivant la valeur mise en cache associée à la
clé fournie.
Paramètres
api.cache.get(key)
Récupère l’enregistrement décrivant la valeur mise en cache associée à la clé fournie,
s’il existe. Si un enregistrement est trouvé, la valeur mise en cache se trouve
dans la propriété value de l’objet retourné.
Paramètres
api.cache.set(key, value, options)
Stocke ou met à jour une valeur de type chaîne dans le cache sous la clé spécifiée.
Les valeurs stockées dans ce cache sont limitées au déclencheur dans lequel elles
sont définies. Elles sont soumises aux limites du cache Actions.
Les valeurs stockées de cette façon auront une durée de vie pouvant aller jusqu’aux valeurs
ttl ou expires_at spécifiées. Si aucune durée de vie n’est spécifiée, une durée de vie
par défaut de 15 minutes sera utilisée. Les durées de vie ne peuvent pas dépasser la durée
maximale indiquée dans les limites du cache Actions.
Important : Ce cache est conçu pour stocker des données éphémères à court terme. Les éléments pourraient ne pas être
disponibles lors de transactions ultérieures, même si leur durée de vie n’est pas encore écoulée.
Paramètres