Share via

InteractiveBrowserCredentialBuilder Class

Package:
com.azure.identity
Maven Artifact:
com.azure:azure-identity:1.18.1

public class InteractiveBrowserCredentialBuilder
extends AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

Fluent credential builder for instantiating a InteractiveBrowserCredential.

Interactive browser authentication is a type of authentication flow offered by Microsoft Entra ID that enables users to sign in to applications and services using a web browser. This authentication method is commonly used for web applications, where users enter their credentials directly into a web page. With interactive browser authentication, the user navigates to a web application and is prompted to enter their username and password credentials. The application then redirects the user to the Microsoft Entra ID sign-in page, where they are prompted to enter their credentials again. After the user successfully authenticates, Microsoft Entra ID issues a security token that the application can use to authorize the user's access to its resources. The InteractiveBrowserCredential interactively authenticates a user and acquires a token with the default system browser and offers a smooth authentication experience by letting a user use their own credentials to authenticate the application. When authenticated, the oauth2 flow notifies the credential of the authentication code through the reply URL. For more information refer to the conceptual knowledge and configuration details.

Sample: Construct InteractiveBrowserCredential

The following code sample demonstrates the creation of a InteractiveBrowserCredential, using the InteractiveBrowserCredentialBuilder to configure it. By default, the credential targets a localhost redirect URL, to override that behaviour a redirectUrl(String redirectUrl) can be optionally specified. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.

TokenCredential interactiveBrowserCredential = new InteractiveBrowserCredentialBuilder().redirectUrl(
     "http://localhost:8765").build();

Constructor Summary

Constructor Description
InteractiveBrowserCredentialBuilder()

Constructs an instance of InteractiveBrowserCredentialBuilder.

Method Summary

Modifier and Type Method and Description
InteractiveBrowserCredentialBuilder additionallyAllowedTenants(List<String> additionallyAllowedTenants)

For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
InteractiveBrowserCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

For multi-tenant applications, specifies additional tenants for which the credential may acquire tokens.
InteractiveBrowserCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)

Sets the AuthenticationRecord captured from a previous authentication.
InteractiveBrowserCredentialBuilder browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions)

Configures the options for customizing the browser for interactive authentication.
InteractiveBrowserCredential build()

Creates a new InteractiveBrowserCredential with the current configurations.
InteractiveBrowserCredentialBuilder clientId(String clientId)

Sets the client ID of the Microsoft Entra application that users will sign in to.
InteractiveBrowserCredentialBuilder disableAutomaticAuthentication()

Disables the automatic authentication and prevents the InteractiveBrowserCredential from automatically prompting the user.
InteractiveBrowserCredentialBuilder loginHint(String loginHint)

Sets the username suggestion to pre-fill the login page's username/email address field.
InteractiveBrowserCredentialBuilder port(int port)

Deprecated

Configure the redirect URL as http://localhost:{port} via redirectUrl(String redirectUrl) instead.

Sets the port for the local HTTP server, for which http://localhost:{port} must be registered as a valid reply URL on the application.
InteractiveBrowserCredentialBuilder redirectUrl(String redirectUrl)

Sets the Redirect URL where STS will callback the application with the security code.
InteractiveBrowserCredentialBuilder