InteractiveCredentialOptions

Common constructor options for the Identity credentials that requires user interaction.

Hierarchy

TokenCredentialOptions
- InteractiveCredentialOptions
  - UsernamePasswordCredentialOptions
  - 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 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 tokenCachePersistenceOptions

tokenCachePersistenceOptions: TokenCachePersistenceOptions

To provide a persistence layer to store the credentials, we allow users to optionally specify TokenCachePersistenceOptions for their credential.

This feature is not currently available on Node 8 or earlier versions of Node JS.

This persistence layer uses DPAPI on Windows. On OSX (Darwin) it tries to use the system's Keychain, otherwise if the property allowUnencryptedStorage is set to true, it uses an unencrypted file. On Linux it tries to use the system's Keyring, otherwise if the property allowUnencryptedStorage is set to true, it uses an unencrypted file.