apps-script-utils (Français) 2.1.1 Help

requireValidToken

function requireValidToken( token: unknown, allowedKeys: string | string[] | Record<string, unknown>, message: string = "Invalid API key." ): string;

Les clés autorisées peuvent être une chaîne, une liste, ou un objet dont les clés sont les jetons. C'est le contrôle à l'entrée d'une application web : il renvoie le jeton pour que l'appel tienne en une expression, et lève une exception nommée sinon.

Paramètres

Paramètre

Type

Description

token

unknown

Le jeton présenté par l'appelant.

allowedKeys

string \| string[] \| Record<string, unknown>

Une clé, une liste de clés, ou un objet indexé par celles-ci.

message (facultatif) = "Invalid API key."

string

Le message de l'exception. "Invalid API key." par défaut.

Valeur de retour

string — le jeton, inchangé.

Exceptions

Exception

Condition

AuthenticationException

le jeton est absent ou ne correspond à aucune clé autorisée.

Exemples

Utilisation

function doPost(event) { const key = requireValidToken( event.parameter.key, PropertiesService.getScriptProperties().getProperty("API_KEYS").split(","), "Unknown API key." ); // … the request is from someone we know }

Voir aussi

Code source

src/appsscript/net/requireValidToken.ts

23 September 2026

Cette documentation a été générée par une IA (Claude) à partir du code source de la bibliothèque.