com.microsoft.aad.msal4j

Class OnBehalfOfParameters.OnBehalfOfParametersBuilder

java.lang.Object

com.microsoft.aad.msal4j.OnBehalfOfParameters.OnBehalfOfParametersBuilder

Enclosing class:

OnBehalfOfParameters

public static class OnBehalfOfParameters.OnBehalfOfParametersBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
OnBehalfOfParameters	build()
OnBehalfOfParameters.OnBehalfOfParametersBuilder	claims(ClaimsRequest claims) Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
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.
OnBehalfOfParameters.OnBehalfOfParametersBuilder	extraHttpHeaders(Map<String,String> extraHttpHeaders) Adds additional headers to the token request
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.
OnBehalfOfParameters.OnBehalfOfParametersBuilder	scopes(Set<String> scopes)
OnBehalfOfParameters.OnBehalfOfParametersBuilder	skipCache(Boolean skipCache) Indicates whether the request should skip looking into the token cache.
OnBehalfOfParameters.OnBehalfOfParametersBuilder	tenant(String tenant) Overrides the tenant value in the authority URL for this request
String	toString()
OnBehalfOfParameters.OnBehalfOfParametersBuilder	userAssertion(IUserAssertion userAssertion)

Methods inherited from class java.lang.Object

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

Method Detail

scopes

public OnBehalfOfParameters.OnBehalfOfParametersBuilder scopes(Set<String> 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.

userAssertion

public OnBehalfOfParameters.OnBehalfOfParametersBuilder userAssertion(IUserAssertion userAssertion)

claims

public OnBehalfOfParameters.OnBehalfOfParametersBuilder claims(ClaimsRequest claims)

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

extraHttpHeaders

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

Adds additional headers to the token request

extraQueryParameters

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

tenant

public OnBehalfOfParameters.OnBehalfOfParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request

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

build

public OnBehalfOfParameters build()

toString

public String toString()

Overrides:

toString in class Object