Share via

OnBehalfOfParameters.OnBehalfOfParametersBuilder Class

  • Reference
Package:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.19.1
  • 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 extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adds additional headers to the token request
OnBehalfOfParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Adds additional parameters to the token request
OnBehalfOfParametersBuilder scopes(@NonNull 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(@NonNull 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

Returns:

this.

extraHttpHeaders

public OnBehalfOfParameters.OnBehalfOfParametersBuilder extraHttpHeaders(Map extraHttpHeaders)

Adds additional headers to the token request

Parameters:

extraHttpHeaders

Returns:

this.

extraQueryParameters

public OnBehalfOfParameters.OnBehalfOfParametersBuilder extraQueryParameters(Map extraQueryParameters)

Adds additional parameters to the token request

Parameters:

extraQueryParameters

Returns:

this.

scopes

public OnBehalfOfParameters.OnBehalfOfParametersBuilder scopes(@NonNull Set scopes)

Parameters:

scopes

Returns:

this.

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

Returns:

this.

tenant

public OnBehalfOfParameters.OnBehalfOfParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request

Parameters:

tenant

Returns:

this.

toString

public String toString()

Overrides:

OnBehalfOfParameters.OnBehalfOfParametersBuilder.toString()

userAssertion

public OnBehalfOfParameters.OnBehalfOfParametersBuilder userAssertion(@NonNull IUserAssertion userAssertion)

Parameters:

userAssertion

Returns:

this.

Applies to