Saltar al contenido principal
El objeto de API del desencadenador de Actions pre-user-registration incluye:

api.access

Permite modificar el acceso del usuario que inicia sesión, por ejemplo, para rechazar el intento de inicio de sesión.

api.access.deny(reason, userMessage)

Impide que el usuario se registre. El flujo de registro se detendrá inmediatamente al completarse esta acción y no se ejecutarán más Actions.
reason
string
Un motivo interno que describe por qué se deniega este intento de registro. Este valor aparecerá en los registros del inquilino.
userMessage
string
Una explicación en lenguaje claro de por qué se rechaza el intento de registro. Puede mostrarse directamente en las interfaces para el usuario final.

api.user

Realiza cambios en los metadatos del usuario que inicia sesión.

api.user.setAppMetadata(key, value)

Establece metadatos específicos de la aplicación para el usuario que inicia sesión. Nota: Este método no debe usarse en callbacks. Al invocarlo, los metadatos no se actualizarán de inmediato. Puede llamarlo varias veces a lo largo de varias Actions del mismo flujo, y el motor acumulará los cambios y actualizará los metadatos de una sola vez antes de que se complete el flujo.
key
string
La propiedad de metadatos que se va a establecer.
value
unknown
El valor de la propiedad de metadatos. Puede establecerse en null para eliminar la propiedad de metadatos.

api.user.setUserMetadata(key, value)

Establece metadatos generales para el usuario que inicia sesión. Nota: Este método no debe usarse en callbacks. Invocar este método no actualizará los metadatos de inmediato. Puede llamar a este método varias veces a lo largo de múltiples Actions del mismo flujo, y el motor agregará los cambios y actualizará los metadatos de una sola vez antes de que se complete el flujo.
key
string
La propiedad de metadatos que se va a establecer.
value
unknown
El valor de la propiedad de metadatos. Puede establecerse en null para eliminar la propiedad de metadatos.

api.cache

Almacena y recupera datos que se conservan entre ejecuciones.

api.cache.delete(key)

Elimina un registro que describe un valor 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)

Recupera un registro que describe un valor en caché en la clave proporcionada, si existe. Si se encuentra un registro, el valor en caché está disponible en la propiedad value del objeto devuelto.
key
string
La clave del registro almacenado en la 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 caché de Actions. Los valores almacenados de esta manera tendrán una vigencia de hasta los valores especificados en ttl o expires_at. Si no se especifica ninguna vigencia, se usará una vigencia predeterminada de 15 minutos. Las vigencias no pueden superar la duración máxima indicada en límites de 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, incluso si aún se encuentran dentro de la vigencia indicada.
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.validation

Modifica el acceso del usuario que inicia sesión, por ejemplo, rechazando el intento de inicio de sesión debido a errores de validación.

api.validation.error(errorCode, errorMessage)

Impide que el usuario se registre. El flujo de registro se detendrá inmediatamente después de que se complete esta acción y no se ejecutará ninguna Actions adicional.
errorCode
string
Un code de error definido por el cliente que describe por qué se rechaza este intento de registro. Este valor aparecerá en los registros del inquilino.
errorMessage
string
Una explicación definida por el cliente para rechazar el intento de registro. Puede mostrarse directamente en las interfaces de usuario final.