Déclencheurs d’actions : credentials-exchange - API Object

L’API Object du déclencheur d’actions credentials-exchange comprend :

api.access

Contrôle de la disponibilité du jeton d’accès.

api.access.deny(code, reason)

Marquer l’échange de jetons en cours comme refusé.

Renvoie une référence à l’objet api.

Paramètre Description
code

Chaîne. Le code d’erreur OAuth justifiant le rejet de la connexion. Doit être l’une des valeurs suivantes : 'invalid_scope', 'invalid_request', ou 'server_error'

reason

Chaîne. Une explication lisible par l’œil humain du rejet de l’octroi du jeton d’accès.

api.accessToken

Demande de modification du jeton d’accès en cours d’émission.

api.accessToken.setCustomClaim(name, value)

Définir une demande personnalisée sur le jeton d’accès qui sera émis dans le cadre de cet échange.

Renvoie une référence à l’objet api.

Paramètre Description
name

Chaîne. Nom de la demande (il peut s’agir d’une adresse URL entièrement qualifiée).

value

Toute valeur. La valeur de la demande.

api.cache

Stockez et récupérez des données qui persistent entre les exécutions.

api.cache.delete(key)

Supprimez un enregistrement décrivant une valeur mise en cache sous la clé fournie, le cas échéant.

Renvoie un objet CacheWriteResult avec type: "success" si une valeur a été supprimée du cache. Une opération échouée renvoie type: "error". En cas d’erreur, l’objet renvoyé affichera une propriété code qui indique la nature de l’échec.

Paramètre Description
key

Chaîne. La clé de l’enregistrement stockée dans le cache.

api.cache.get(key)

Récupère un enregistrement décrivant une valeur mise en cache sous la clé key fournie, le cas échéant. Si un enregistrement est trouvé, la valeur mise en cache peut être trouvée dans la propriété value de l’objet retourné.

Renvoie un enregistrement si un élément est trouvé dans le cache sous la key fournie. Les enregistrements de cache sont des objets dotés d’une propriété value contenant la valeur mise en cache et d’une propriété expires_at indiquant l’heure d’expiration maximale de l’enregistrement, en millisecondes depuis l’époque Unix.

Important : Ce cache est conçu pour des données éphémères de courte durée. Certains éléments peuvent ne pas être disponibles lors de transactions ultérieures, même s’ils sont encore dans la limite de leur durée de vie.

Paramètre Description
key

Chaîne. La clé de l’enregistrement stockée dans le cache.

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

Stockez ou mettez à jour la valeur d’une chaîne dans le cache sous 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 soumises aux Limites de cache des actions.

Les valeurs stockées de cette manière auront des durées de vie allant jusqu’aux valeurs ttl ou expires_at spécifiées. Si aucune durée de vie n’est spécifiée, elle sera de 15 minutes par défaut. Les durées de vie ne doivent pas dépasser la durée maximale indiquée dans Limites de caches des actions.

Paramètre Description
key

Chaîne. La clé de l’enregistrement stockée dans le cache.
value

Chaîne. La valeur de l’enregistrement à stocker.
options

Objet facultatif. Options permettant de régler le comportement du cache.
options.expires_at

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

Remarque : Cette valeur ne doit pas être fournie si une valeur a également été donnée pour ttl. La première des deux échéances sera retenue si les deux options sont fournies.

options.ttl

Numéro facultatif. Valeur de la durée de vie de cette entrée de cache en millisecondes. Bien que les valeurs mises en cache puissent être expulsés plus tôt, elles ne resteront jamais au-delà de la valeur ttl fournie.

Remarque : Cette valeur ne doit pas être fournie si une valeur a également été donnée pour expires_at. La première des deux échéances sera retenue si les deux options sont fournies.