CommunicationTokenRefreshOptions interface

Optionen zum automatischen Aktualisieren von Anmeldeinformationen für Kommunikationstoken.

Eigenschaften

refreshProactively

Gibt an, ob das Token proaktiv vor ablaufen oder nur bei Bedarf verlängert werden soll. Standardmäßig "false".

token

Optionales Token, das initialisiert werden soll. Es kann ein string oder ein AccessToken explizites Ablaufdatum sein.

tokenRefresher

Callback, der ein Token zurückgibt, das von der Communication Identity API erworben wurde. Das zurückgegebene Token muss gültig sein (Ablaufdatum muss in der Zukunft sein).

Return a string , um den Ablauf aus dem JWT lesen zu lassen, oder an AccessToken um den Ablauf explizit bereitzustellen (erforderlich für verschlüsselte Zugriffstoken, die nicht entschlüsselt werden können).

undecodableTokenExpiryIntervalInSeconds

Lebensdauer, in Sekunden, angenommen für ein zurückgegebenes Token, das nicht decodiert werden kann und kein explizites Ablaufdatum hat (z. B. ein verschlüsseltes Zugriffstoken). Standardmäßig 600 (10 Minuten).

Setze das auf die reale Lebensdauer deiner Tokens. Sie ist nicht gedeckelt: Ein Wert, der größer ist als die tatsächliche Lebensdauer des Tokens, bedeutet, dass die Zugangsdaten später aktualisiert werden und der Dienst das abgelaufene Token ablehnt. Um Raten zu vermeiden, bevorzuge es, ein AccessToken mit einem expliziten expiresOnTimestamp (z. B. abgeleitet von der expires_inToken-Antwort ) zurückzugeben.

Details zur Eigenschaft

refreshProactively

Gibt an, ob das Token proaktiv vor ablaufen oder nur bei Bedarf verlängert werden soll. Standardmäßig "false".

refreshProactively?: boolean

Eigenschaftswert

boolean

token

Optionales Token, das initialisiert werden soll. Es kann ein string oder ein AccessToken explizites Ablaufdatum sein.

token?: string | AccessToken

Eigenschaftswert

string | AccessToken

tokenRefresher

Callback, der ein Token zurückgibt, das von der Communication Identity API erworben wurde. Das zurückgegebene Token muss gültig sein (Ablaufdatum muss in der Zukunft sein).

Return a string , um den Ablauf aus dem JWT lesen zu lassen, oder an AccessToken um den Ablauf explizit bereitzustellen (erforderlich für verschlüsselte Zugriffstoken, die nicht entschlüsselt werden können).

tokenRefresher: (abortSignal?: AbortSignalLike) => Promise<string | AccessToken>

Eigenschaftswert

(abortSignal?: AbortSignalLike) => Promise<string | AccessToken>

undecodableTokenExpiryIntervalInSeconds

Lebensdauer, in Sekunden, angenommen für ein zurückgegebenes Token, das nicht decodiert werden kann und kein explizites Ablaufdatum hat (z. B. ein verschlüsseltes Zugriffstoken). Standardmäßig 600 (10 Minuten).

Setze das auf die reale Lebensdauer deiner Tokens. Sie ist nicht gedeckelt: Ein Wert, der größer ist als die tatsächliche Lebensdauer des Tokens, bedeutet, dass die Zugangsdaten später aktualisiert werden und der Dienst das abgelaufene Token ablehnt. Um Raten zu vermeiden, bevorzuge es, ein AccessToken mit einem expliziten expiresOnTimestamp (z. B. abgeleitet von der expires_inToken-Antwort ) zurückzugeben.

undecodableTokenExpiryIntervalInSeconds?: number

Eigenschaftswert

number