InteractiveRequestParameters Class

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

Implements

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

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

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

Method Summary

Modifier and Type Method and Description
static InteractiveRequestParametersBuilder builder(URI redirectUri)
ClaimsRequest claims()

Gets the claims request parameter that will be sent with the authentication request.
java.lang.String claimsChallenge()
java.lang.String domainHint()
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.
int httpPollingTimeoutInSeconds()
boolean instanceAware()
java.lang.String loginHint()
Prompt prompt()
PopParameters proofOfPossession()
java.net.URI redirectUri()
java.util.Set<java.lang.String> scopes()

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

Gets the tenant identifier for the token request.
long windowHandle()

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 InteractiveRequestParameters.InteractiveRequestParametersBuilder builder(URI redirectUri)

Parameters:

redirectUri

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.

claimsChallenge

public String claimsChallenge()

domainHint

public String domainHint()

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.

httpPollingTimeoutInSeconds

public int httpPollingTimeoutInSeconds()

instanceAware

public boolean instanceAware()

loginHint

public String loginHint()

prompt

public Prompt prompt()

proofOfPossession

public PopParameters proofOfPossession()

redirectUri

public URI redirectUri()

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.

systemBrowserOptions

public SystemBrowserOptions systemBrowserOptions()

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

windowHandle

public long windowHandle()

Applies to