GetTokenOptions interface

Package:

@azure/identity

Defines options for TokenCredential.getToken.

Properties

abortSignal	The signal which can be used to abort requests.
claims	Claim details to perform the Continuous Access Evaluation authentication flow
enableCae	Indicates whether to enable the Continuous Access Evaluation authentication flow
proofOfPossessionOptions	Options for Proof of Possession token requests
requestOptions	Options used when creating and sending HTTP requests for this operation.
tenantId	Allows specifying a tenantId. Useful to handle challenges that provide tenant Id hints.
tracingOptions	Options used when tracing is enabled.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

claims

Claim details to perform the Continuous Access Evaluation authentication flow

claims?: string

Property Value

string

enableCae

Indicates whether to enable the Continuous Access Evaluation authentication flow

enableCae?: boolean

Property Value

boolean

proofOfPossessionOptions

Options for Proof of Possession token requests

proofOfPossessionOptions?: { nonce: string, resourceRequestMethod: HttpMethods, resourceRequestUrl: string }

Property Value

{ nonce: string, resourceRequestMethod: HttpMethods, resourceRequestUrl: string }

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: { timeout?: number }

Property Value

{ timeout?: number }

tenantId

Allows specifying a tenantId. Useful to handle challenges that provide tenant Id hints.

tenantId?: string

Property Value

string

tracingOptions

Options used when tracing is enabled.

tracingOptions?: { tracingContext?: TracingContext }

Property Value

{ tracingContext?: TracingContext }