DeviceCodeCredentialOptions

Defines options for the InteractiveBrowserCredential class for NodeJS.

Hierarchy

InteractiveCredentialOptions
- DeviceCodeCredentialOptions

Index

Properties

Optional authenticationRecord

authenticationRecord: AuthenticationRecord

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();

Optional authorityHost

authorityHost: undefined | string

The authority host to use for authentication requests. The default is "https://login.microsoftonline.com".

Optional clientId

clientId: undefined | string

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

Optional disableAutomaticAuthentication

disableAutomaticAuthentication: undefined | false | true

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

Optional tenantId

tenantId: undefined | string

The Azure Active Directory tenant (directory) ID.

Optional userPromptCallback

userPromptCallback: DeviceCodePromptCallback

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.