requireValidToken

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

Die erlaubten Schlüssel dürfen eine einzelne Zeichenkette, eine Liste oder ein Objekt sein, dessen Schlüssel die Token sind. Das ist die Prüfung an der Tür einer Web-App: sie gibt das Token zurück, damit der Aufruf ein Ausdruck bleibt, und wirft sonst eine benannte Ausnahme.

Parameter

Parameter	Typ	Beschreibung
`token`	`unknown`	Das vom Aufrufer vorgelegte Token.
`allowedKeys`	`string \\| string[] \\| Record<string, unknown>`	Ein Schlüssel, eine Liste von Schlüsseln oder ein danach indiziertes Objekt.
`message` (optional) `= "Invalid API key."`	`string`	Die Meldung der Ausnahme. Standardmäßig `"Invalid API key."`.

Rückgabewert

string — das Token, unverändert.

Ausnahmen

Ausnahme	Bedingung
`AuthenticationException`	das Token fehlt oder passt zu keinem erlaubten Schlüssel.

Beispiele

Im Einsatz

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
}

Siehe auch

Quellcode

src/appsscript/net/requireValidToken.ts

23 September 2026

Diese Dokumentation wurde mit KI (Claude) aus dem Quellcode der Bibliothek erzeugt.