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() Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
Map<String,String>	extraHttpHeaders() Adds additional headers to the token request
Map<String,String>	extraQueryParameters() Adds additional parameters to the token request
@NonNull Set<String>	scopes()
Boolean	skipCache() Indicates whether the request should skip looking into the token cache.
String	tenant() Overrides the tenant value in the authority URL for this request
@NonNull 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

@NonNull
public @NonNull Set<String> scopes()

skipCache

public Boolean skipCache()

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

userAssertion

@NonNull
public @NonNull IUserAssertion userAssertion()

claims

public ClaimsRequest claims()

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

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Adds additional headers to the token request

extraQueryParameters

public Map<String,String> extraQueryParameters()

Adds additional parameters to the token request

tenant

public String tenant()

Overrides the tenant value in the authority URL for this request