api.access
api.access.deny(reason)
string
Une explication en langage clair du refus de la réinitialisation du mot de passe. Elle peut être affichée
directement dans les interfaces utilisateur.
api.authentication
api.authentication.challengeWith(factor, options)
- Il réussit le défi pour le facteur par défaut.
- Il réussit le défi pour l’un des facteurs facultatifs décrits dans
additionalFactors.
Cette méthode affichera un écran de défi de facteur si l’utilisateur n’a pas déjà satisfait
aux exigences du défi. Si
additionalFactors est fourni, l’utilisateur pourra
sélectionner un autre facteur s’il le souhaite.factorselector
Un objet qui décrit le type de facteur et les options à utiliser pour le défi initial.
challengewithoptions
optional
Options supplémentaires qui peuvent aussi inclure
additionalFactors comme propriété.api.authentication.challengeWithAny(factors)
- Il réussit le défi pour l’un des facteurs.
Cette méthode affichera l’écran de sélection du facteur si l’utilisateur n’a pas déjà satisfait
aux exigences du défi. S’il existe un facteur privilégié, il est préférable d’utiliser la méthode
api.authentication.challengeWith().
L’écran de sélection du facteur ne s’affichera pas si un seul facteur est transmis ou valide.array of objects
Un tableau de facteurs.
api.redirect
api.redirect.encodeToken(options)
sendUserTo) et
contenant des données dont l’authenticité doit pouvoir être prouvé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 validant la signature du JWT
à l’aide d’un secret partagé.
Le secret partagé doit être stocké comme secret de l’Action et sera accessible dans
event.secrets['<secret_name>'].
tokencreationoptions
Configurez la façon dont les données sensibles sont encodées dans les paramètres de requête de l’URL
résultante.
api.redirect.sendUserTo(url, options)
url cible dans le pipeline de réinitialisation du mot de passe, immédiatement après
la fin de cette action. La méthode utilitaire createUrl est fournie pour simplifier l’encodage des
données en tant que paramètre de requête dans l’url cible, afin que l’authenticité et
l’intégrité des données puissent être vérifiées par le point de terminaison cible.
string
sendusertooptions
optional
api.redirect.validateToken(options)
/continue tout en vérifiant
l’authenticité et l’intégrité de ces données.
validatesessiontokenoptions
Options pour récupérer les données encodées dans un JWT transmis au
point de terminaison
/continue après une redirection.api.cache
api.cache.delete(key)
string
La clé du Record de cache à supprimer.
api.cache.get(key)
value de l’objet retourné.
string
La clé du Record stocké dans le cache.
api.cache.set(key, value, options)
ttl ou expires_at. 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 Actions Cache Limits.
Important : Ce cache est conçu pour des données éphémères de courte durée. Il se peut que des éléments ne soient pas
disponibles dans des transactions ultérieures, même si leur durée de vie n’est pas encore expirée.
string
La clé du Record à stocker.
string
La valeur du Record à stocker.
cachesetoptions
optional
Options pour ajuster le comportement du cache.
api.prompt
api.prompt.render(promptId, promptOptions)
string
L’ID de l’invite.
promptoptions
optional
Les options de rendu.
api.transaction
api.transaction.setResultUrl(url, options)
string
L’URL vers laquelle rediriger l’utilisateur.
resulturloptions
optional