AuthorizationCodeParameters Class

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

Implements

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Object containing parameters for authorization code flow. Can be used as parameter to PublicClientApplication#acquireToken(AuthorizationCodeParameters) or to ConfidentialClientApplication#acquireToken(AuthorizationCodeParameters)

Method Summary

Modifier and Type Method and Description
java.lang.String authorizationCode()
static AuthorizationCodeParametersBuilder builder(String authorizationCode, URI redirectUri)

Builder for AuthorizationCodeParameters
ClaimsRequest claims()

Gets the claims request parameter that will be sent with the authentication request.
java.lang.String clientClaims()

Client-originated claims set via AuthorizationCodeParametersBuilder#claimsFromClient(String).
java.lang.String codeVerifier()
java.lang.String computeExtCacheKeyHash()

Computes the extended cache key hash from all cache key components, or an empty string when there are none.
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.
java.net.URI redirectUri()
java.util.Set<java.lang.String> scopes()

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

Gets the tenant identifier for the token request.

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

authorizationCode

public String authorizationCode()

builder

public static AuthorizationCodeParameters.AuthorizationCodeParametersBuilder builder(String authorizationCode, URI redirectUri)

Builder for AuthorizationCodeParameters

Parameters:

authorizationCode - code received from the service authorization endpoint
redirectUri - URI where authorization code was received

Returns:

builder object that can be used to construct AuthorizationCodeParameters

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.

clientClaims

public String clientClaims()

Client-originated claims set via AuthorizationCodeParametersBuilder#claimsFromClient(String). Forwarded to the token endpoint as the OAuth claims parameter and used as part of the extended cache key so that distinct claim values are cached separately.

codeVerifier

public String codeVerifier()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Computes the extended cache key hash from all cache key components, or an empty string when there are none. The result is memoized since the parameters are immutable after construction.

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.

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.

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

Applies to