com.microsoft.aad.msal4j

Class InteractiveRequestParameters

java.lang.Object

com.microsoft.aad.msal4j.InteractiveRequestParameters

public class InteractiveRequestParameters
extends Object

Object containing parameters for interactive requests. Can be used as parameter to PublicClientApplication.acquireToken(InteractiveRequestParameters).

For more details, see https://aka.ms/msal4j-interactive-request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InteractiveRequestParameters.InteractiveRequestParametersBuilder

Method Summary

Modifier and Type	Method and Description
static InteractiveRequestParameters.InteractiveRequestParametersBuilder	builder(URI redirectUri)
ClaimsRequest	claims() Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
String	claimsChallenge()
String	domainHint() Provides a hint about the tenant or domain that the user should use to sign in.
Map<String,String>	extraHttpHeaders() Adds additional headers to the token request
Map<String,String>	extraQueryParameters() Adds additional query parameters to the token request
int	httpPollingTimeoutInSeconds() The amount of time in seconds that the library will wait for an authentication result.
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.
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.
Prompt	prompt() Indicate the type of user interaction that is required.
PopParameters	proofOfPossession()
@NonNull URI	redirectUri() Redirect URI where MSAL will listen to for the authorization code returned by Azure AD.
Set<String>	scopes() Scopes that the application is requesting access to and the user will consent to.
SystemBrowserOptions	systemBrowserOptions() Sets SystemBrowserOptions to be used by the PublicClientApplication
String	tenant() Overrides the tenant value in the authority URL for this request
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static InteractiveRequestParameters.InteractiveRequestParametersBuilder builder(URI redirectUri)

redirectUri

@NonNull
public @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.

claims

public ClaimsRequest claims()

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

scopes

public Set<String> scopes()

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

prompt

public Prompt prompt()

Indicate the type of user interaction that is required.

loginHint

public 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.

domainHint

public 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.

systemBrowserOptions

public SystemBrowserOptions systemBrowserOptions()

Sets SystemBrowserOptions to be used by the PublicClientApplication

claimsChallenge

public String claimsChallenge()

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Adds additional headers to the token request

extraQueryParameters

public Map<String,String> extraQueryParameters()

Adds additional query parameters to the token request

tenant

public String tenant()

Overrides the tenant value in the authority URL for this request

httpPollingTimeoutInSeconds

public 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

instanceAware

public 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.

windowHandle

public 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

proofOfPossession

public PopParameters proofOfPossession()