Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InteractiveBrowserCredentialOptions

Package version

Defines the common options for the InteractiveBrowserCredential class.

Hierarchy

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 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 loginHint

loginHint: undefined | string

loginHint allows a user name to be pre-selected for interactive logins. Setting this option skips the account selection prompt and immediately attempts to login with the specified account.

Optional redirectUri

redirectUri: string | (() => string)

Gets the redirect URI of the application. This should be same as the value in the application registration portal. Defaults to window.location.href.

Optional tenantId

tenantId: undefined | string

The Azure Active Directory tenant (directory) ID.

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

-

Generated using TypeDoc