Package version:

Interface InteractiveCredentialOptions

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

interface InteractiveCredentialOptions {
    additionallyAllowedTenants?: {};
    authenticationRecord?: AuthenticationRecord;
    authorityHost?: string;
    disableAutomaticAuthentication?: boolean;
    disableInstanceDiscovery?: boolean;
    loggingOptions?: any;
}

Hierarchy (view full)

Properties

additionallyAllowedTenants? authenticationRecord? authorityHost? disableAutomaticAuthentication? disableInstanceDiscovery? loggingOptions?

Properties

OptionaladditionallyAllowedTenants

additionallyAllowedTenants?: {}

For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the application is installed.

OptionalauthenticationRecord

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

OptionalauthorityHost

authorityHost?: string

The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".

OptionaldisableAutomaticAuthentication

disableAutomaticAuthentication?: boolean

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

OptionaldisableInstanceDiscovery

disableInstanceDiscovery?: boolean

The field determines whether instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. As a result, it's crucial to ensure that the configured authority host is valid and trustworthy. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached, such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority.

OptionalloggingOptions

loggingOptions?: any

Allows users to configure settings for logging policy options, allow logging account information and personally identifiable information for customer support.

Settings

Member Visibility