Skip to main content
Version: v1

TokenFetchOptions Interface

Represents access token fetch options

Signature​

export interface TokenFetchOptions

Properties​

Property Modifiers Type Description
claims optional string Claims that have to be passed with token fetch request. These can be used to specify additional information that must be passed to token authority.
refresh boolean Value indicating whether fresh token has to be returned. If false then it is okay to return cached unexpired token if available.
tenantId optional string Tenant id of authority that must be handling token fetch. If it is not specified then it is up to token fetching logic to determine which tenant authority to use to issue access token.

Property Details​

claims​

Claims that have to be passed with token fetch request. These can be used to specify additional information that must be passed to token authority.

Signature​

claims?: string;

Type: string

refresh​

Value indicating whether fresh token has to be returned. If false then it is okay to return cached unexpired token if available.

Signature​

refresh: boolean;

Type: boolean

tenantId​

Tenant id of authority that must be handling token fetch. If it is not specified then it is up to token fetching logic to determine which tenant authority to use to issue access token.

Signature​

tenantId?: string;

Type: string