DeviceCodeCredentialOptions interface

The client (application) ID of an App Registration in the tenant.

clientId?: string

Property Value

The Microsoft Entra tenant (directory) ID.

tenantId?: string

Property Value

A callback function that will be invoked to show DeviceCodeInfo to the user. If left unassigned, we will automatically log the device code information and the authentication instructions in the console.

userPromptCallback?: DeviceCodePromptCallback

Property Value

For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the application is installed.

additionallyAllowedTenants?: string[]

Property Value

Inherited From InteractiveCredentialOptions.additionallyAllowedTenants

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

Inherited From InteractiveCredentialOptions.additionalPolicies

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

allowInsecureConnection?: boolean

Property Value

Inherited From InteractiveCredentialOptions.allowInsecureConnection

Result of a previous authentication that can be used to retrieve the cached credentials of each individual account. This is necessary to provide in case the application wants to work with more than one account per Client ID and Tenant ID pair.

This record can be retrieved by calling to the credential's authenticate() method, as follows:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Property Value

Inherited From InteractiveCredentialOptions.authenticationRecord

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

Inherited From InteractiveCredentialOptions.authorityHost

Makes getToken throw if a manual authentication is necessary. Developers will need to call to authenticate() to control when to manually authenticate.

disableAutomaticAuthentication?: boolean

Property Value

Inherited From InteractiveCredentialOptions.disableAutomaticAuthentication

The field determines whether instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. As a result, it's crucial to ensure that the configured authority host is valid and trustworthy. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached, such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority.

disableInstanceDiscovery?: boolean

Property Value

Inherited From InteractiveCredentialOptions.disableInstanceDiscovery

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

Inherited From InteractiveCredentialOptions.httpClient

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

Inherited From InteractiveCredentialOptions.loggingOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

Inherited From InteractiveCredentialOptions.proxyOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

Inherited From InteractiveCredentialOptions.redirectOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

Inherited From InteractiveCredentialOptions.retryOptions

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

telemetryOptions?: TelemetryOptions

Property Value

Inherited From InteractiveCredentialOptions.telemetryOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

Inherited From InteractiveCredentialOptions.tlsOptions

Options to provide to the persistence layer (if one is available) when storing credentials.

You must first register a persistence provider plugin. See the @azure/identity-cache-persistence package on NPM.

Example:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Property Value

Inherited From CredentialPersistenceOptions.tokenCachePersistenceOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

Inherited From InteractiveCredentialOptions.userAgentOptions