com.microsoft.aad.msal4j

Class AuthorizationRequestUrlParameters.Builder

java.lang.Object

com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder

Enclosing class:

AuthorizationRequestUrlParameters

public static class AuthorizationRequestUrlParameters.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AuthorizationRequestUrlParameters	build()
AuthorizationRequestUrlParameters.Builder	claims(Set<String> val) Deprecated.
AuthorizationRequestUrlParameters.Builder	claimsChallenge(String val) In cases where Azure AD tenant admin has enabled conditional access policies, and the policy has not been met,MsalServiceException will contain claims that need be consented to.
AuthorizationRequestUrlParameters.Builder	codeChallenge(String val) Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE).
AuthorizationRequestUrlParameters.Builder	codeChallengeMethod(String val) The method used to encode the code verifier for the code challenge parameter.
AuthorizationRequestUrlParameters.Builder	correlationId(String val) Identifier used to correlate requests for telemetry purposes.
AuthorizationRequestUrlParameters.Builder	domainHint(String val) Provides a hint about the tenant or domain that the user should use to sign in.
AuthorizationRequestUrlParameters.Builder	loginHint(String val) 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.
AuthorizationRequestUrlParameters.Builder	nonce(String val) A value included in the request that is also returned in the token response.
AuthorizationRequestUrlParameters.Builder	prompt(Prompt val) Indicates the type of user interaction that is required.
AuthorizationRequestUrlParameters.Builder	redirectUri(String val) The redirect URI where authentication responses can be received by your application.
AuthorizationRequestUrlParameters.Builder	responseMode(ResponseMode val) Specifies the method that should be used to send the authentication result to your app.
AuthorizationRequestUrlParameters.Builder	scopes(Set<String> val) Scopes which the application is requesting access to and the user will consent to.
AuthorizationRequestUrlParameters.Builder	state(String val) A value included in the request that is also returned in the token response.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public AuthorizationRequestUrlParameters build()

redirectUri

public AuthorizationRequestUrlParameters.Builder redirectUri(String val)

The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.

scopes

public AuthorizationRequestUrlParameters.Builder scopes(Set<String> val)

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

claims

@Deprecated
public AuthorizationRequestUrlParameters.Builder claims(Set<String> val)

Deprecated.

In cases where Azure AD tenant admin has enabled conditional access policies, and the policy has not been met,MsalServiceException will contain claims that need be consented to. Deprecated in favor of claimsChallenge(String)

claimsChallenge

public AuthorizationRequestUrlParameters.Builder claimsChallenge(String val)

In cases where Azure AD tenant admin has enabled conditional access policies, and the policy has not been met,MsalServiceException will contain claims that need be consented to.

codeChallenge

public AuthorizationRequestUrlParameters.Builder codeChallenge(String val)

Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). Required if codeChallenge is included. For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636

codeChallengeMethod

public AuthorizationRequestUrlParameters.Builder codeChallengeMethod(String val)

The method used to encode the code verifier for the code challenge parameter. Can be one of plain or S256. If excluded, code challenge is assumed to be plaintext. For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636

state

public AuthorizationRequestUrlParameters.Builder state(String val)

A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.

nonce

public AuthorizationRequestUrlParameters.Builder nonce(String val)

A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks.

responseMode

public AuthorizationRequestUrlParameters.Builder responseMode(ResponseMode val)

Specifies the method that should be used to send the authentication result to your app.

loginHint

public AuthorizationRequestUrlParameters.Builder loginHint(String val)

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 AuthorizationRequestUrlParameters.Builder domainHint(String val)

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.

prompt

public AuthorizationRequestUrlParameters.Builder prompt(Prompt val)

Indicates the type of user interaction that is required. Possible values are Prompt

correlationId

public AuthorizationRequestUrlParameters.Builder correlationId(String val)

Identifier used to correlate requests for telemetry purposes. Usually a GUID.