UsernamePasswordCredentialOptions

Defines options for the UsernamePasswordCredential class.

Hierarchy

TokenCredentialOptions
CredentialPersistenceOptions
- UsernamePasswordCredentialOptions

Index

Properties

Optional allowMultiTenantAuthentication

allowMultiTenantAuthentication: undefined | false | true

If set to true, allows authentication flows to change the tenantId of the request if a different tenantId is received from a challenge or through a direct getToken call.

Optional authorityHost

authorityHost: undefined | string

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

Optional tokenCachePersistenceOptions

tokenCachePersistenceOptions: TokenCachePersistenceOptions

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

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

Example:

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

useIdentityExtension(persistence);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      name: "mycustomcachename"
    }
  });
}

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