Saltar al contenido principal
El objeto de la API del desencadenador de Actions password-reset-post-challenge incluye:

api.access

Modifica el acceso del usuario que está intentando restablecer su contraseña.

api.access.deny(reason)

Marca el intento actual de restablecimiento de contraseña como denegado. Esto impedirá que el usuario final complete el flujo de restablecimiento de contraseña. Esto NO cancelará otros efectos secundarios relacionados con el usuario solicitados por esta Action. El flujo de restablecimiento de contraseña se detendrá inmediatamente tras completarse esta acción y no se ejecutará ninguna Action adicional.
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

Solicita cambios en el estado de autenticación de la sesión del usuario actual.

api.authentication.challengeWith(factor, options)

Solicita un desafío de autenticación multifactor con el factor proporcionado y factores adicionales opcionales. Cuando se solicita un desafío multifactor, las Actions posteriores no se ejecutarán hasta que el usuario haya completado ese desafío. Se considerará que un usuario ha superado el desafío en cualquiera de las siguientes situaciones:
  1. Completa correctamente el desafío para el factor predeterminado.
  2. Completa correctamente el desafío para cualquiera de los factores opcionales descritos en additionalFactors.
Si alguno de los factores solicitados ya se ha completado correctamente en la transacción actual, se ignorará. Si se solicita un factor que no está habilitado en el inquilino, se ignorará. Si se solicita un factor en el que el usuario no se ha inscrito, se ignorará. Si ninguno de los factores solicitados está habilitado o inscrito, la transacción de autenticación fallará (es decir, el inicio de sesión no se completará).
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.
factor
factorselector
Un objeto que describe el tipo de factor y las opciones que deben usarse para el desafío inicial.
options
challengewithoptions
optional
Opciones adicionales que también pueden especificar additionalFactors como una propiedad.

api.authentication.challengeWithAny(factors)

Solicita un desafío de autenticación multifactor con cualquiera de los factores proporcionados (mostrando primero una pantalla de selección de factores). Cuando se solicita un desafío multifactor, las Actions posteriores no se ejecutarán hasta que el usuario haya completado ese desafío. Se considerará que un usuario ha superado el desafío en cualquiera de las siguientes situaciones:
  1. Completa correctamente el desafío para cualquiera de los factores.
Si alguno de los factores solicitados ya se superó correctamente en la transacción actual, se ignorará. Si se solicita un factor que no está habilitado en el inquilino, se ignorará. Si se solicita un factor en el que el usuario no se ha inscrito, se ignorará. Si ninguno de los factores solicitados está habilitado o inscrito, la transacción de autenticación fallará (es decir, el inicio de sesión no se completará).
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.
factors
array of objects
Una lista de factores.

api.redirect

Configura e inicia redirecciones externas.

api.redirect.encodeToken(options)

Crea un token de sesión apto para usarlo como parámetro de cadena de consulta del destino de redirección (mediante 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>'].
options
tokencreationoptions
Configura cómo se codifican los datos sensibles en los parámetros de consulta de la URL resultante.

api.redirect.sendUserTo(url, options)

Hace que el flujo de restablecimiento de contraseña active una redirección del navegador a la 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.
url
string
options
sendusertooptions
optional

api.redirect.validateToken(options)

Recupera los datos codificados en un token JWT que se pasó al endpoint /continue y verifica la autenticidad e integridad de esos datos.
options
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

Permite realizar cambios en la caché.

api.cache.delete(key)

Elimina el registro que describe un valor almacenado en caché en la clave proporcionada, si existe.
key
string
La clave del registro de caché que se va a eliminar.

api.cache.get(key)

Obtiene un registro que describe un valor almacenado en caché para la clave proporcionada, si existe. Si se encuentra un registro, el valor almacenado en caché está en la propiedad value del objeto devuelto.
key
string
La clave del registro almacenado en caché.

api.cache.set(key, value, options)

Almacena o actualiza un valor de cadena en la caché con la clave especificada. Los valores almacenados en esta caché se limitan al desencadenador en el que se establecen. Están sujetos a los límites de la caché de Actions. Los valores almacenados de esta forma tendrán una duración de hasta los valores especificados en 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.
key
string
La clave del registro que se almacenará.
value
string
El valor del registro que se almacenará.
options
cachesetoptions
optional
Opciones para ajustar el comportamiento de la caché.

api.prompt

Muestra una pantalla personalizada.

api.prompt.render(promptId, promptOptions)

Renderiza una pantalla personalizada.
promptId
string
El ID de la pantalla.
promptOptions
promptoptions
optional
Las opciones de renderizado.

api.transaction

Configura la transacción.

api.transaction.setResultUrl(url, options)

Establece la URL a la que se debe redirigir al usuario después de restablecer la contraseña.
url
string
La URL a la que se redirigirá al usuario.
options
resulturloptions
optional