api.access
api.access.deny(reason)
string
Una explicación en lenguaje claro del motivo por el que se rechaza el restablecimiento de contraseña. Puede mostrarse
directamente en las interfaces del usuario final.
api.authentication
api.authentication.challengeWith(factor, options)
- Completa correctamente el desafío para el factor predeterminado.
- Completa correctamente el desafío para cualquiera de los factores opcionales descritos en
additionalFactors.
Este método hará que se muestre una pantalla de desafío del factor si el usuario aún no ha cumplido
los requisitos del desafío. Si se proporcionan
additionalFactors, el usuario tendrá la opción de
seleccionar otro factor si así lo desea.factorselector
Un objeto que describe el tipo de factor y las opciones que deben usarse para el desafío inicial.
challengewithoptions
optional
Opciones adicionales que también pueden especificar
additionalFactors como una propiedad.api.authentication.challengeWithAny(factors)
- Completa correctamente el desafío para cualquiera de los factores.
Este método hará que se muestre la pantalla de selección de factores si el usuario aún no ha cumplido
los requisitos del desafío. Si hay un factor preferido, se prefiere el método
api.authentication.challengeWith().
La pantalla de selección de factores no se mostrará si solo se pasa un factor o si solo uno es válido.array of objects
Una lista de factores.
api.redirect
api.redirect.encodeToken(options)
sendUserTo)
que contenga datos cuya autenticidad deba poder demostrarse ante el endpoint de destino. El endpoint de destino
puede verificar la autenticidad e integridad de los datos comprobando la firma del JWT
mediante un secreto compartido.
El secreto compartido debe almacenarse como un secret de la Action y podrá leerse en
event.secrets['<secret_name>'].
tokencreationoptions
Configura cómo se codifican los datos sensibles en los parámetros de consulta de la
URL resultante.
api.redirect.sendUserTo(url, options)
url de destino inmediatamente después de que
se complete esta acción. El método auxiliar createUrl se proporciona para simplificar la codificación de
datos como parámetro de consulta en la url de destino, de modo que el endpoint de destino pueda verificar la autenticidad y la
integridad de los datos.
string
sendusertooptions
optional
api.redirect.validateToken(options)
/continue y verifica
la autenticidad e integridad de esos datos.
validatesessiontokenoptions
Opciones para recuperar los datos codificados en un token JWT que se pasó al
endpoint
/continue después de una redirección.api.cache
api.cache.delete(key)
string
La clave del registro de caché que se va a eliminar.
api.cache.get(key)
value del objeto devuelto.
string
La clave del registro almacenado en caché.
api.cache.set(key, value, options)
ttl o expires_at. Si no se especifica ninguna duración, se usará una
duración predeterminada de 15 minutos. Las duraciones no pueden superar la duración máxima
indicada en los límites de la caché de Actions.
Importante: Esta caché está diseñada para datos efímeros de corta duración. Es posible que los elementos no estén
disponibles en transacciones posteriores aunque sigan dentro del tiempo de vida especificado.
string
La clave del registro que se almacenará.
string
El valor del registro que se almacenará.
cachesetoptions
optional
Opciones para ajustar el comportamiento de la caché.
api.prompt
api.prompt.render(promptId, promptOptions)
string
El ID de la pantalla.
promptoptions
optional
Las opciones de renderizado.
api.transaction
api.transaction.setResultUrl(url, options)
string
La URL a la que se redirigirá al usuario.
resulturloptions
optional