Passer au contenu principal
L’objet API du déclencheur pre-user-registration d’Actions comprend :

​
api.access

Modifiez l’accès de l’utilisateur qui se connecte, par exemple en rejetant la tentative de connexion.

​
api.access.deny(reason, userMessage)

Empêche l’utilisateur de s’inscrire. Le flux d’inscription s’arrête immédiatement une fois cette action terminée, et aucune autre Action n’est exécutée.
​
reason
string
Motif interne décrivant pourquoi cette tentative d’inscription est refusée. Cette valeur apparaîtra dans les journaux du locataire.
​
userMessage
string
Explication en langage clair du rejet de la tentative d’inscription. Elle peut être affichée directement dans les interfaces utilisateur finales.

​
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 se connecte. Remarque : cette méthode ne doit pas être utilisée dans les rappels. Son appel ne met pas à jour les métadonnées immédiatement. Vous pouvez l’appeler plusieurs fois dans plusieurs Actions d’un même flux, et le moteur regroupera les modifications et mettra à jour les métadonnées en une seule fois avant la fin du flux.
​
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.user.setUserMetadata(key, value)

Définit des métadonnées générales 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 à jour les métadonnées immédiatement. Vous pouvez l’appeler plusieurs fois dans plusieurs Actions d’un même flux, et le moteur regroupera les modifications et mettra à jour les métadonnées en une seule fois avant la fin du flux.
​
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

Stocke et récupère des données qui persistent d’une exécution à l’autre.

​
api.cache.delete(key)

Supprime l’enregistrement décrivant une valeur mise en cache pour la clé fournie, s’il existe.
​
key
string
La clé de l’enregistrement du cache à supprimer.

​
api.cache.get(key)

Récupère un enregistrement décrivant une valeur en cache associée à la clé fournie, s’il existe. Si un enregistrement est trouvé, la valeur en cache se trouve dans la propriété value de l’objet renvoyé.
​
key
string
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é spécifiée. Les valeurs stockées dans ce cache sont limitées au déclencheur dans lequel elles sont définies. Elles sont assujetties aux limites du cache des Actions. Les valeurs stockées de cette façon auront une durée de vie pouvant aller jusqu’aux valeurs ttl ou expires_at spécifié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 de courte durée. Il est possible que des éléments ne soient pas disponibles dans des transactions ultérieures, même s’ils sont encore dans leur durée de vie prévue.
​
key
string
La clé de l’enregistrement à stocker.
​
value
string
La valeur de l’enregistrement à stocker.
​
options
cachesetoptions
optional
Options permettant d’ajuster le comportement du cache.

​
api.validation

Modifiez l’accès de l’utilisateur qui tente de se connecter, par exemple en rejetant la 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 à la fin de cette action, et aucune autre Action n’est exécutée.
​
errorCode
string
Un code d’erreur défini par le client qui explique pourquoi cette tentative d’inscription est refusée. Cette valeur apparaîtra dans les journaux du locataire.
​
errorMessage
string
Une explication définie par le client pour justifier le refus de la tentative d’inscription. Elle peut être affichée directement dans les interfaces des utilisateurs finaux.