CommunicationTokenRefreshOptions interface

Paquete:: @azure/communication-common

Opciones para actualizar automáticamente una credencial de token de comunicación.

Propiedades

refreshProactively	Indica si el token se debe renovar de forma proactiva antes de la expiración o solo renovar a petición. De forma predeterminada, false.
token	Token opcional que se va a inicializar. Puede ser una `string` o una `AccessToken` que tenga una expiración explícita.
tokenRefresher	Callback que devuelve un token adquirido de la API de Identidad de Comunicación. El token devuelto debe ser válido (la fecha de expiración debe estar en el futuro). Devuelve a `string` para que la expiración sea leída del JWT, o para `AccessToken` proporcionar la expiración explícitamente (requerida para tokens de acceso cifrados que no pueden ser decodificados).
undecodableTokenExpiryIntervalInSeconds	Vida útil, en segundos, asumida para un token devuelto que no puede ser decodificado y que no conlleva caducidad explícita (por ejemplo, un token de acceso cifrado). Por defecto es 600 (10 minutos). Configura esto como la vida real de tus tokens. No está limitado: un valor mayor que la vida real del token significa que la credencial se actualiza más tarde de lo que debería y el servicio rechazará el token caducado. Para evitar adivinar, prefiero devolver an `AccessToken` con un explícito `expiresOnTimestamp` (por ejemplo, derivado de la respuesta del `expires_in`token ).

Detalles de las propiedades

refreshProactively

Indica si el token se debe renovar de forma proactiva antes de la expiración o solo renovar a petición. De forma predeterminada, false.

refreshProactively?: boolean

Valor de propiedad

boolean

token

Token opcional que se va a inicializar. Puede ser una string o una AccessToken que tenga una expiración explícita.

token?: string | AccessToken

Valor de propiedad

string | AccessToken

tokenRefresher

Callback que devuelve un token adquirido de la API de Identidad de Comunicación. El token devuelto debe ser válido (la fecha de expiración debe estar en el futuro).

Devuelve a string para que la expiración sea leída del JWT, o para AccessToken proporcionar la expiración explícitamente (requerida para tokens de acceso cifrados que no pueden ser decodificados).

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

Valor de propiedad

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

undecodableTokenExpiryIntervalInSeconds

Vida útil, en segundos, asumida para un token devuelto que no puede ser decodificado y que no conlleva caducidad explícita (por ejemplo, un token de acceso cifrado). Por defecto es 600 (10 minutos).

Configura esto como la vida real de tus tokens. No está limitado: un valor mayor que la vida real del token significa que la credencial se actualiza más tarde de lo que debería y el servicio rechazará el token caducado. Para evitar adivinar, prefiero devolver an AccessToken con un explícito expiresOnTimestamp (por ejemplo, derivado de la respuesta del expires_intoken ).

undecodableTokenExpiryIntervalInSeconds?: number

Valor de propiedad

number