OnBehalfOfParameters.OnBehalfOfParametersBuilder Class

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

public static class OnBehalfOfParameters.OnBehalfOfParametersBuilder

Method Summary

Modifier and Type Method and Description
OnBehalfOfParameters build()
OnBehalfOfParametersBuilder claims(ClaimsRequest claims)

Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
OnBehalfOfParametersBuilder claimsFromClient(String claimsJson)

Specifies client-originated claims (a raw JSON object string) to forward to the token endpoint as the OAuth claims request parameter.
OnBehalfOfParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adds additional headers to the token request
OnBehalfOfParametersBuilder 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 parameters to the token request
OnBehalfOfParametersBuilder scopes(Set<String> scopes)
OnBehalfOfParametersBuilder skipCache(Boolean skipCache)

Indicates whether the request should skip looking into the token cache.
OnBehalfOfParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request
java.lang.String toString()
OnBehalfOfParametersBuilder userAssertion(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

build

public OnBehalfOfParameters build()

claims

public OnBehalfOfParameters.OnBehalfOfParametersBuilder claims(ClaimsRequest claims)

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

Parameters:

claims

claimsFromClient

public OnBehalfOfParameters.OnBehalfOfParametersBuilder 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 claims) (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.

Parameters:

claimsJson - a valid JSON object string containing the client claims

Returns:

this builder instance

extraHttpHeaders

public OnBehalfOfParameters.OnBehalfOfParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adds additional headers to the token request

Parameters:

extraHttpHeaders

extraQueryParameters


public OnBehalfOfParameters.OnBehalfOfParametersBuilder 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 parameters to the token request

Parameters:

extraQueryParameters

scopes

public OnBehalfOfParameters.OnBehalfOfParametersBuilder scopes(Set<String> scopes)

Parameters:

scopes

skipCache

public OnBehalfOfParameters.OnBehalfOfParametersBuilder skipCache(Boolean skipCache)

Indicates whether the request should skip looking into the token cache. Be default it is set to false.

Parameters:

skipCache

tenant

public OnBehalfOfParameters.OnBehalfOfParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request

Parameters:

tenant

toString

public String toString()

Overrides:

OnBehalfOfParameters.OnBehalfOfParametersBuilder.toString()

userAssertion

public OnBehalfOfParameters.OnBehalfOfParametersBuilder userAssertion(IUserAssertion userAssertion)

Parameters:

userAssertion

Applies to