com.microsoft.aad.msal4j

Class AuthorizationCodeParameters.AuthorizationCodeParametersBuilder

java.lang.Object

com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder

Enclosing class:

AuthorizationCodeParameters

public static class AuthorizationCodeParameters.AuthorizationCodeParametersBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	authorizationCode(String authorizationCode) Authorization code acquired in the first step of OAuth2.0 authorization code flow.
AuthorizationCodeParameters	build()
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	claims(ClaimsRequest claims) Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	claimsFromClient(String claimsJson) Specifies client-originated claims (a raw JSON object string) to forward to the token endpoint as the OAuth claims request parameter.
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	codeVerifier(String codeVerifier) Code verifier used for PKCE.
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	extraHttpHeaders(Map<String,String> extraHttpHeaders) Adds additional headers to the token request
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	extraQueryParameters(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.
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	redirectUri(URI redirectUri) Redirect URI registered in the Azure portal, and which was used in the first step of OAuth2.0 authorization code flow.
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	scopes(Set<String> scopes) Scopes to which the application is requesting access
AuthorizationCodeParameters.AuthorizationCodeParametersBuilder	tenant(String tenant) Overrides the tenant value in the authority URL for this request
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

authorizationCode

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder authorizationCode(String authorizationCode)

Authorization code acquired in the first step of OAuth2.0 authorization code flow. For more details, see https://aka.ms/msal4j-authorization-code-flow

Cannot be null.

redirectUri

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder redirectUri(URI redirectUri)

Redirect URI registered in the Azure portal, and which was used in the first step of OAuth2.0 authorization code flow. For more details, see https://aka.ms/msal4j-authorization-code-flow

Cannot be null.

scopes

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder scopes(Set<String> scopes)

Scopes to which the application is requesting access

claims

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder claims(ClaimsRequest claims)

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

codeVerifier

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder codeVerifier(String codeVerifier)

Code verifier used for PKCE. For more details, see https://tools.ietf.org/html/rfc7636

extraHttpHeaders

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adds additional headers to the token request

extraQueryParameters

@Deprecated
public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder extraQueryParameters(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.

Adds additional query parameters to the token request

tenant

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request

claimsFromClient

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder claimsFromClient(String claimsJson)

Specifies client-originated claims (a raw JSON object string) to forward to the token endpoint as the OAuth claims request parameter. Unlike claims(ClaimsRequest) (server-issued claims challenges, which bypass the cache), tokens acquired with client claims are cached and the cache entry is keyed on the claims value, so distinct claim values produce separate cache entries. Use stable, non-dynamic values to avoid cache fragmentation. Send the identical value on every request for a given token; because the raw value is part of the cache key, changing or omitting it routes the request to a different cache partition. A blank value is ignored; an invalid JSON object throws MsalClientException.

Client claims are primarily intended for confidential-client web apps, but AuthorizationCodeParameters is also accepted by PublicClientApplication, so this method is visible there too. The same cache caveat applies to both application types: a token acquired with client claims is stored under the extended cache key, while a later acquireTokenSilently call (which uses SilentParameters and cannot carry client claims) will not match that entry and will instead refresh without the client claims. The claims are applied only on the acquire/redemption call that sets them; to apply them again, redeem through this builder rather than relying on a silent refresh.

Parameters:

claimsJson - a valid JSON object string containing the client claims

Returns:

this builder instance

build

public AuthorizationCodeParameters build()

toString

public String toString()

Overrides:

toString in class Object