UsernamePasswordCredential Class

  • Reference
Package:
com.azure.identity
Maven Artifact:
com.azure:azure-identity:1.12.0
  • java.lang.Object
    • com.azure.identity.UsernamePasswordCredential

Implements

TokenCredential

public class UsernamePasswordCredential
implements TokenCredential

Username password authentication is a common type of authentication flow used by many applications and services, including Microsoft Entra ID. With username password authentication, users enter their username and password credentials to sign in to an application or service. The UsernamePasswordCredential authenticates a public client application and acquires a token using the user credentials that don't require 2FA/MFA (Multi-factored) authentication. For more information refer to the conceptual knowledge and configuration details.

In the scenario where 2FA/MFA (Multi-factored) authentication is turned on, please use DeviceCodeCredential or InteractiveBrowserCredential instead.

Sample: Construct UsernamePasswordCredential

The following code sample demonstrates the creation of a UsernamePasswordCredential, using the UsernamePasswordCredentialBuilder to configure it. The clientId, username and password parameters are required to create UsernamePasswordCredential. 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 usernamePasswordCredential = new UsernamePasswordCredentialBuilder()
     .clientId("<your app client ID>")
     .username("<your username>")
     .password("<your password>")
     .build();

Method Summary

Modifier and Type Method and Description
Mono<AuthenticationRecord> authenticate()

Authenticates the user using the specified username and password.
Mono<AuthenticationRecord> authenticate(TokenRequestContext request)

Authenticates the user using the specified username and password.
Mono<AccessToken> getToken(TokenRequestContext request)
AccessToken getTokenSync(TokenRequestContext request)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

authenticate

public Mono authenticate()

Authenticates the user using the specified username and password.

Returns:

The AuthenticationRecord of the authenticated account.

authenticate

public Mono authenticate(TokenRequestContext request)

Authenticates the user using the specified username and password.

Parameters:

request - The details of the authentication request.

Returns:

The AuthenticationRecord of the authenticated account.

getToken

public Mono getToken(TokenRequestContext request)

Parameters:

request

getTokenSync

public AccessToken getTokenSync(TokenRequestContext request)

Parameters:

request

Applies to