Objet API

Découvrez l’objet API du déclencheur credentials-exchange des Actions.

L’objet API du déclencheur credentials-exchange des Actions comprend :

​

api.access

Gérez la disponibilité du jeton d’accès.

​

api.access.deny(code, reason)

Marque l’échange de jetons en cours comme rejeté.

Paramètres

Masquer Paramètres

code · string

Le code d’erreur propre au protocole justifiant le rejet de la connexion. Valeurs autorisées : invalid_scope, invalid_request, server_error

reason · string

Une explication compréhensible par une personne du rejet de l’autorisation du jeton d’accès. Facultatif.

​

api.accessToken

Demande de modifications au jeton d’accès en cours d’émission.

​

api.accessToken.setCustomClaim(key, value)

Définit une revendication personnalisée dans le jeton d’accès qui sera émis.

Paramètres

Masquer Paramètres

key · string

Nom de la revendication (il peut devoir s’agir d’une URL complète).

value · unknown

Valeur de la revendication.

​

api.cache

Modifiez le cache.

​

api.cache.delete(key)

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

Paramètres

Masquer Paramètres

key · string

La clé de l’enregistrement mis en cache à supprimer.

​

api.cache.get(key)

Récupère un enregistrement décrivant une valeur mise en cache associée à 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 renvoyé.

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 sous 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 Actions Cache Limits.

Les valeurs stockées de cette façon auront une durée de vie allant 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 Actions Cache Limits.

Important : Ce cache est conçu pour stocker des données éphémères à court terme. 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 d’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, la date d’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, la date d’expiration la plus rapprochée sera utilisée. Facultatif.

​

api.transaction

[Accès anticipé] Modifiez la transaction.

​

api.transaction.addTargetScope(scope)

[Accès anticipé] Ajoute une portée à l’ensemble des portées cibles. Les portées ajoutées sont recoupées avec l’autorisation du client une fois toutes les Actions terminées. Les portées qui ne figurent pas dans l’autorisation sont retirées silencieusement du jeton d’accès final.

exports.onExecuteCredentialsExchange = async (event, api) => {
  api.transaction.addTargetScope('read:reports');
};

Paramètres

Masquer Paramètres

scope · string

La portée à ajouter.

​

api.transaction.removeTargetScope(scope)

[Accès anticipé] Supprime une portée de l’ensemble de portées cible.

exports.onExecuteCredentialsExchange = async (event, api) => {
  api.transaction.removeTargetScope('admin:full');
};

Paramètres

Masquer Paramètres

scope · string

La portée à supprimer.

​

api.transaction.setTargetScopes(scopes)

[Accès anticipé] Remplace l’ensemble des portées cibles. Les nouvelles portées sont combinées avec l’autorisation du client une fois toutes les Actions terminées. Les portées absentes de l’autorisation sont automatiquement exclues du jeton d’accès final.

exports.onExecuteCredentialsExchange = async (event, api) => {
  api.transaction.setTargetScopes(['read:users', 'write:users']);
};

Paramètres

Masquer Paramètres

scopes · array of string

Le nouvel ensemble de portées cibles.

​

api.transaction.clearTargetScopes()

[Accès anticipé] Supprime toutes les portées de l’ensemble de portées cible.

exports.onExecuteCredentialsExchange = async (event, api) => {
  api.transaction.clearTargetScopes();
};