Objet API

Découvrez l’objet API du déclencheur d’Actions pre-user-registration.

L’objet API du déclencheur d’Actions pre-user-registration comprend :

​

api.access

Modifiez l’accès de l’utilisateur qui tente de se connecter, par exemple en rejetant sa tentative de connexion.

​

api.access.deny(reason, userMessage)

Empêche l’utilisateur de s’inscrire. Le flux d’inscription s’arrête immédiatement après l’exécution de cette action, et aucune autre Action n’est exécutée.

Paramètres

Masquer Paramètres

reason · string

Une raison interne expliquant le rejet de cette tentative d’inscription. Cette valeur s’affiche dans les logs du tenant.

userMessage · string

Une explication compréhensible par une personne expliquant le rejet de la tentative d’inscription. Elle peut être affichée directement dans les interfaces destinées aux utilisateurs finaux.

​

api.user

Modifiez les métadonnées de l’utilisateur qui se connecte.

​

api.user.setAppMetadata(key, value)

Définissez des métadonnées propres à l’application pour l’utilisateur qui ouvre une session.

Remarque : cette méthode ne doit pas être utilisée dans les callbacks. Son appel ne met pas les métadonnées à jour immédiatement. Vous pouvez l’appeler plusieurs fois dans différentes actions d’un même flux, et le moteur regroupera les modifications et mettra les métadonnées à jour en une seule fois avant la fin du flux.

Paramètres

Masquer Paramètres

key · string

La propriété de métadonnées à définir.

value · unknown

La valeur de la propriété de métadonnées. Vous pouvez lui attribuer la valeur null pour supprimer la propriété de métadonnées.

​

api.user.setUserMetadata(key, value)

Définit les métadonnées générales de l’utilisateur qui se connecte.

Remarque : cette méthode ne doit pas être utilisée dans les callbacks. Son appel ne met pas immédiatement à jour les métadonnées. Vous pouvez l’appeler plusieurs fois dans différentes actions du même flux, et le moteur regroupera les modifications pour mettre à jour les métadonnées en une seule fois avant la fin du flux.

Paramètres

Masquer Paramètres

key · string

La propriété de métadonnées à définir.

value · unknown

La valeur de la propriété de métadonnées. Elle peut être définie à null pour supprimer la propriété de métadonnées.

​

api.cache

Enregistrez et récupérez des données qui persistent d’une exécution à l’autre.

​

api.cache.delete(key)

Supprime, s’il existe, l’enregistrement associé à une valeur mise en cache à la clé fournie.

Paramètres

Masquer Paramètres

key · string

La clé de l’enregistrement du cache à supprimer.

​

api.cache.get(key)

Récupère l’enregistrement associé à une valeur mise en cache à 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

Masquer Paramètres

key · string

La clé de l’enregistrement stocké dans le cache.

​

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

Stocke ou met à jour une valeur de type chaîne dans le cache à la clé indiquée.

Les valeurs stockées dans ce cache sont limitées au Trigger dans lequel elles sont définies. Elles sont soumises aux limites du cache des Actions.

Les valeurs ainsi stockées auront une durée de vie pouvant aller jusqu’aux valeurs ttl ou expires_at indiquées. Si aucune durée de vie n’est précisé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 des Actions.

Important : Ce cache est conçu pour des données éphémères à courte durée de vie. Les éléments peuvent 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

Masquer Paramètres

key · string

La clé de l’enregistrement à stocker.

value · string

La valeur de l’enregistrement à stocker.

options · cachesetoptions

Options permettant d’ajuster le comportement du cache. Facultatif.

Afficher propriétés des options

expires_at · number

L’heure d’expiration absolue en millisecondes depuis l’époque Unix. Bien que les enregistrements mis en cache puissent être évincés plus tôt, ils ne seront jamais conservés au-delà de la valeur expires_at fournie.

Remarque : Cette valeur ne doit pas être fournie si une valeur a aussi été fournie pour ttl. Si les deux options sont fournies, l’expiration la plus rapprochée sera utilisée. Facultatif.

ttl · number

La durée de vie de cette entrée de cache en millisecondes. Bien que les valeurs mises en cache puissent être évincées plus tôt, elles ne seront jamais conservées au-delà de la valeur ttl fournie.

Remarque : Cette valeur ne doit pas être fournie si une valeur a aussi été fournie pour expires_at. Si les deux options sont fournies, l’expiration la plus rapprochée sera utilisée. Facultatif.

​

api.validation

Modifiez l’accès de l’utilisateur qui se connecte, par exemple en rejetant sa tentative de connexion en raison d’erreurs de validation.

​

api.validation.error(errorCode, errorMessage)

Empêche l’utilisateur de s’inscrire. Le flux d’inscription s’arrête immédiatement après l’exécution de cette action, et aucune autre action n’est exécutée.

Paramètres

Masquer Paramètres

errorCode · string

Code d’erreur défini par le client indiquant pourquoi cette tentative d’inscription est rejetée. Cette valeur apparaîtra dans les logs du tenant.

errorMessage · string

Explication définie par le client justifiant le rejet de la tentative d’inscription. Elle peut être affichée directement dans les interfaces destinées aux utilisateurs finaux.