Share via

OnBehalfOfParameters Class

  • Reference
Package:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.17.2
  • 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()

Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Adds additional headers to the token request
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Adds additional parameters to the token request
@lombok.NonNull java.util.Set<java.lang.String> scopes()
java.lang.Boolean skipCache()

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

Overrides the tenant value in the authority URL for this request
@lombok.NonNull com.microsoft.aad.msal4j.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 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()

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

extraHttpHeaders

public Map extraHttpHeaders()

Adds additional headers to the token request

extraQueryParameters

public Map extraQueryParameters()

Adds additional parameters to the token request

scopes

public @NonNull Set scopes()

skipCache

public Boolean skipCache()

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

tenant

public String tenant()

Overrides the tenant value in the authority URL for this request

userAssertion

public @NonNull IUserAssertion userAssertion()

Applies to