CommunicationTokenRefreshOptions interface

自動重新整理通訊令牌認證的選項。

屬性

refreshProactively

指出令牌應該在到期前主動更新,還是只視需要續約。 默認為 false。

token

要初始化的選擇性令牌。 可能是stringAccessToken明確的到期日。

tokenRefresher

回調回傳從通訊身份 API 取得的令牌。 傳回的令牌必須有效(到期日必須在未來)。

回傳 a string 以從 JWT 讀取到期日,或 A AccessToken 明確提供到期日期(對於無法解碼的加密存取權杖)。

undecodableTokenExpiryIntervalInSeconds

假設無法解碼且無明確到期期限的回傳權杖(例如加密的存取權杖)壽命(以秒計)。 預設為600(10分鐘)。

將此設定為你代幣的真實壽命。 它沒有上限:值大於代幣實際壽命,代表憑證更新時間會比預期晚,服務會拒絕過期的憑證。 為避免猜測,建議回傳 an AccessToken 並明確表示 expiresOnTimestamp (例如由標記回應 expires_in推導出)。

屬性詳細資料

refreshProactively

指出令牌應該在到期前主動更新,還是只視需要續約。 默認為 false。

refreshProactively?: boolean

屬性值

boolean

token

要初始化的選擇性令牌。 可能是stringAccessToken明確的到期日。

token?: string | AccessToken

屬性值

string | AccessToken

tokenRefresher

回調回傳從通訊身份 API 取得的令牌。 傳回的令牌必須有效(到期日必須在未來)。

回傳 a string 以從 JWT 讀取到期日,或 A AccessToken 明確提供到期日期(對於無法解碼的加密存取權杖)。

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

屬性值

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

undecodableTokenExpiryIntervalInSeconds

假設無法解碼且無明確到期期限的回傳權杖(例如加密的存取權杖)壽命(以秒計)。 預設為600(10分鐘)。

將此設定為你代幣的真實壽命。 它沒有上限:值大於代幣實際壽命,代表憑證更新時間會比預期晚,服務會拒絕過期的憑證。 為避免猜測,建議回傳 an AccessToken 並明確表示 expiresOnTimestamp (例如由標記回應 expires_in推導出)。

undecodableTokenExpiryIntervalInSeconds?: number

屬性值

number