com.microsoft.aad.msal4j

Class OnBehalfOfParameters

java.lang.Object

com.microsoft.aad.msal4j.OnBehalfOfParameters

public class OnBehalfOfParameters
extends Object

Object containing parameters for On-Behalf-Of flow. Can be used as parameter to ConfidentialClientApplication.acquireToken(OnBehalfOfParameters)

For more details, see https://aka.ms/msal4j-on-behalf-of

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OnBehalfOfParameters.OnBehalfOfParametersBuilder

Method Summary

Modifier and Type	Method and Description
static OnBehalfOfParameters.OnBehalfOfParametersBuilder	builder(Set<String> scopes, UserAssertion userAssertion) Builder for OnBehalfOfParameters
ClaimsRequest	claims() Gets the claims request parameter that will be sent with the authentication request.
String	clientClaims() Client-originated claims set via OnBehalfOfParameters.OnBehalfOfParametersBuilder.claimsFromClient(String).
String	computeExtCacheKeyHash() Computes the extended cache key hash from all cache key components, or an empty string when there are none.
Map<String,String>	extraHttpHeaders() Gets additional HTTP headers to be included in the token request.
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.
Set<String>	scopes() Gets the set of scopes (permissions) requested for the access token.
Boolean	skipCache()
String	tenant() Gets the tenant identifier for the token request.
IUserAssertion	userAssertion()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static OnBehalfOfParameters.OnBehalfOfParametersBuilder builder(Set<String> scopes,
                                                                       UserAssertion userAssertion)

Builder for OnBehalfOfParameters

Parameters:

scopes - scopes application is requesting access to

userAssertion - UserAssertion created from access token received

Returns:

builder that can be used to construct OnBehalfOfParameters

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.

Returns:

A set of scope strings being requested for the access token.

skipCache

public Boolean skipCache()

userAssertion

public IUserAssertion userAssertion()

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.

Returns:

A ClaimsRequest object containing the requested claims, or null if no claims are specified.

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.

Returns:

A map of additional HTTP headers to include with the token request, or null if no extra headers are needed.

extraQueryParameters

@Deprecated
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.

Returns:

A map of additional query parameters to include with the token request, or null if no extra parameters are needed.

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

Returns:

The tenant identifier to use for the token request, or null to use the tenant from the authority URL.

clientClaims

public String clientClaims()

Client-originated claims set via OnBehalfOfParameters.OnBehalfOfParametersBuilder.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.

Returns:

the client-originated claims JSON, or null if none were provided.

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.

Returns:

the Base64URL-encoded SHA-256 hash of the cache-key components, or an empty string.