TokenCredentialOptions interface

Package:

@azure/identity

Provides options to configure how the Identity library makes authentication requests to Microsoft Entra ID.

Extends

CommonClientOptions

Properties

authorityHost	The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".
loggingOptions	Allows users to configure settings for logging policy options, allow logging account information and personally identifiable information for customer support.

Inherited Properties

additionalPolicies	Additional policies to include in the HTTP pipeline.
allowInsecureConnection	Set to true if the request is sent over HTTP instead of HTTPS
httpClient	The HttpClient that will be used to send HTTP requests.
proxyOptions	Options to configure a proxy for outgoing requests.
redirectOptions	Options for how redirect responses are handled.
retryOptions	Options that control how to retry failed requests.
telemetryOptions	Options for setting common telemetry and tracing info to outgoing requests.
tlsOptions	Options for configuring TLS authentication
userAgentOptions	Options for adding user agent details to outgoing requests.

Property Details

authorityHost

The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".

authorityHost?: string

Property Value

string

loggingOptions

Allows users to configure settings for logging policy options, allow logging account information and personally identifiable information for customer support.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Property Value

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Inherited Property Details

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

AdditionalPolicyConfig[]

Inherited From CommonClientOptions.additionalPolicies

allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS

allowInsecureConnection?: boolean

Property Value

boolean

Inherited From CommonClientOptions.allowInsecureConnection

httpClient

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

HttpClient

Inherited From CommonClientOptions.httpClient

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From CommonClientOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

Inherited From CommonClientOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From CommonClientOptions.retryOptions

telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.

telemetryOptions?: TelemetryOptions

Property Value

TelemetryOptions

Inherited From CommonClientOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From CommonClientOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From CommonClientOptions.userAgentOptions