UserNamePasswordParameters Class

Package:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.UserNamePasswordParameters

Implements

com.microsoft.aad.msal4j.IAcquireTokenParameters


public class UserNamePasswordParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

Object containing parameters for Username/Password flow. Can be used as parameter to acquireToken(UserNamePasswordParameters parameters)

Deprecated: This class supports the Resource Owner Password Credentials (ROPC) flow, which is insecure and will be removed in a future release.

See https://aka.ms/msal-ropc-migration for migration guidance.

For more details, see https://aka.ms/msal4j-username-password

Method Summary

Modifier and Type Method and Description
static UserNamePasswordParametersBuilder builder(Set<String> scopes, String username, char[] password)

Builder for UserNameParameters
ClaimsRequest claims()

Gets the claims request parameter that will be sent with the authentication request.
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Gets additional HTTP headers to be included in the token request.
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Deprecated

Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.

Gets additional query parameters to be included in the token request.
char[] password()
PopParameters proofOfPossession()
java.util.Set<java.lang.String> scopes()

Gets the set of scopes (permissions) requested for the access token.
java.lang.String tenant()

Gets the tenant identifier for the token request.
java.lang.String username()

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

builder

public static UserNamePasswordParameters.UserNamePasswordParametersBuilder builder(Set<String> scopes, String username, char[] password)

Builder for UserNameParameters

Parameters:

scopes - scopes application is requesting access to
username - username of the account
password - char array containing credentials for the username

Returns:

builder object that can be used to construct UserNameParameters

claims

public ClaimsRequest claims()

Gets the claims request parameter that will be sent with the authentication request.

The claims request parameter can be used to request specific claims to be returned in the token, to request MFA authentication, or to control other aspects of token issuance.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Gets additional HTTP headers to be included in the token request.

These headers will be added to the HTTP requests sent to the token endpoint. This can be useful for scenarios requiring custom headers for proxies or for diagnostic purposes.

extraQueryParameters


public Map<String,String> extraQueryParameters()

Deprecated

Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.

Gets additional query parameters to be included in the token request.

These parameters will be added to the query string in requests to the authorization and token endpoints. This can be useful for scenarios requiring custom parameters that aren't explicitly supported in the library.

password

public char[] password()

proofOfPossession

public PopParameters proofOfPossession()

scopes

public Set<String> scopes()

Gets the set of scopes (permissions) requested for the access token.

Scopes represent the permissions that the application is requesting access to.

tenant

public String tenant()

Gets the tenant identifier for the token request.

When specified, this value overrides the tenant specified in the application's authority URL. It can be a tenant ID (GUID), domain name, or one of the special values like "common" or "organizations".

username

public String username()

Applies to