Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InteractiveBrowserCredentialInBrowserOptions

Package version

Defines the common options for the InteractiveBrowserCredential class.

Hierarchy

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. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".

clientId

clientId: string

The client (application) ID of an App Registration in the tenant. This parameter is required on the browser.

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 loggingOptions

loggingOptions: LogPolicyOptions & { allowLoggingAccountIdentifiers?: undefined | false | true }

Allows logging account information once the authentication flow succeeds.

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 loginStyle

loginStyle: BrowserLoginStyle

Specifies whether a redirect or a popup window should be used to initiate the user authentication flow. Possible values are "redirect" or "popup" (default) for browser and "popup" (default) for node.

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.

Generated using TypeDoc