OnBehalfOfParameters Class

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

Implements

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

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

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

Method Summary

Modifier and Type Method and Description
static 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.
java.lang.String clientClaims()

Client-originated claims set via OnBehalfOfParametersBuilder#claimsFromClient(String).
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.util.Set<java.lang.String> scopes()

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

Gets the tenant identifier for the token request.
IUserAssertion userAssertion()

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

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

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.

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.

skipCache

public Boolean skipCache()

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

userAssertion

public IUserAssertion userAssertion()

Applies to