InteractiveRequestParameters.InteractiveRequestParametersBuilder Class

Package:

com.microsoft.aad.msal4j

Maven Artifact:

com.microsoft.azure:msal4j:1.19.1

• java.lang.Object
• • com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

Method Summary

Modifier and Type	Method and Description
InteractiveRequestParameters	build()
InteractiveRequestParametersBuilder	claims(ClaimsRequest claims) Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
InteractiveRequestParametersBuilder	claimsChallenge(String claimsChallenge)
InteractiveRequestParametersBuilder	domainHint(String domainHint) Provides a hint about the tenant or domain that the user should use to sign in.
InteractiveRequestParametersBuilder	extraHttpHeaders(Map<String,String> extraHttpHeaders) Adds additional headers to the token request
InteractiveRequestParametersBuilder	extraQueryParameters(Map<String,String> extraQueryParameters) Adds additional query parameters to the token request
InteractiveRequestParametersBuilder	httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds) The amount of time in seconds that the library will wait for an authentication result.
InteractiveRequestParametersBuilder	instanceAware(boolean instanceAware) If set to true, the authorization result will contain the authority for the user's home cloud, and this authority will be used for the token request instead of the authority set in the application.
InteractiveRequestParametersBuilder	loginHint(String loginHint) Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time.
InteractiveRequestParametersBuilder	prompt(Prompt prompt) Indicate the type of user interaction that is required.
InteractiveRequestParametersBuilder	proofOfPossession(HttpMethod httpMethod, URI uri, String nonce) Sets the PopParameters for this request, allowing the request to retrieve proof-of-possession tokens rather than bearer tokens For more information, see PopParameters and https://aka.ms/msal4j-pop
InteractiveRequestParametersBuilder	redirectUri(@NonNull URI redirectUri) Redirect URI where MSAL will listen to for the authorization code returned by Azure AD.
InteractiveRequestParametersBuilder	scopes(Set<String> scopes) Scopes that the application is requesting access to and the user will consent to.
InteractiveRequestParametersBuilder	systemBrowserOptions(SystemBrowserOptions systemBrowserOptions) Sets SystemBrowserOptions to be used by the PublicClientApplication
InteractiveRequestParametersBuilder	tenant(String tenant) Overrides the tenant value in the authority URL for this request
java.lang.String	toString()
InteractiveRequestParametersBuilder	windowHandle(long windowHandle) The parent window handle used to open UI elements with the correct parent For browser scenarios and Windows console applications, this value should not need to be set For Windows console applications, MSAL Java will attempt to discover the console's window handle if this parameter is not set For scenarios where MSAL Java is responsible for opening UI elements (such as when using MSALRuntime), this parameter is required and an exception will be thrown if not set

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

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims

Parameters:

claims

Returns:

this.

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Parameters:

claimsChallenge

Returns:

this.

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.

Parameters:

domainHint

Returns:

this.

extraHttpHeaders

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraHttpHeaders(Map extraHttpHeaders)

Adds additional headers to the token request

Parameters:

extraHttpHeaders

Returns:

this.

extraQueryParameters

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraQueryParameters(Map extraQueryParameters)

Adds additional query parameters to the token request

Parameters:

extraQueryParameters

Returns:

this.

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

The amount of time in seconds that the library will wait for an authentication result. 120 seconds is the default timeout, unless overridden here with some other positive integer If this timeout is set to 0 or less it will be ignored, and the library will use a 1 second timeout instead

Parameters:

httpPollingTimeoutInSeconds

Returns:

this.

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

If set to true, the authorization result will contain the authority for the user's home cloud, and this authority will be used for the token request instead of the authority set in the application.

Parameters:

instanceAware

Returns:

this.

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the preferred_username claim.

Parameters:

loginHint

Returns:

this.

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

Indicate the type of user interaction that is required.

Parameters:

prompt

Returns:

this.

proofOfPossession

public InteractiveRequestParameters.InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Sets the PopParameters for this request, allowing the request to retrieve proof-of-possession tokens rather than bearer tokens For more information, see PopParameters and https://aka.ms/msal4j-pop

Parameters:

httpMethod - a valid HTTP method, such as "GET" or "POST"

uri - the URI on the downstream protected API which the application is trying to access, e.g. https://graph.microsoft.com/beta/me/profile

nonce - a string obtained by calling the resource (e.g. Microsoft Graph) un-authenticated and parsing the WWW-Authenticate header associated with pop authentication scheme and extracting the nonce parameter, or, on subsequent calls, by parsing the Autheticate-Info header and extracting the nextnonce parameter.

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(@NonNull URI redirectUri)

Redirect URI where MSAL will listen to for the authorization code returned by Azure AD. Should be a loopback address with a port specified (for example, http://localhost:3671). If no port is specified, MSAL will find an open port. For more information, see https://aka.ms/msal4j-interactive-request.

Parameters:

redirectUri

Returns:

this.

scopes

public InteractiveRequestParameters.InteractiveRequestParametersBuilder scopes(Set scopes)

Scopes that the application is requesting access to and the user will consent to.

Parameters:

scopes

Returns:

this.

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Sets SystemBrowserOptions to be used by the PublicClientApplication

Parameters:

systemBrowserOptions

Returns:

this.

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request

Parameters:

tenant

Returns:

this.

toString

public String toString()

Overrides:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

The parent window handle used to open UI elements with the correct parent For browser scenarios and Windows console applications, this value should not need to be set For Windows console applications, MSAL Java will attempt to discover the console's window handle if this parameter is not set For scenarios where MSAL Java is responsible for opening UI elements (such as when using MSALRuntime), this parameter is required and an exception will be thrown if not set

Parameters:

windowHandle

Returns:

this.