com.microsoft.aad.msal4j

Class SilentParameters

java.lang.Object

com.microsoft.aad.msal4j.SilentParameters

public class SilentParameters
extends Object

Object containing parameters for silent requests. Can be used as parameter to AbstractClientApplicationBase.acquireTokenSilently(SilentParameters) or to AbstractClientApplicationBase.acquireTokenSilently(SilentParameters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SilentParameters.SilentParametersBuilder

Method Summary

Modifier and Type	Method and Description
IAccount	account() Account for which you are requesting a token for.
String	authorityUrl() Authority for which the application is requesting tokens from.
static SilentParameters.SilentParametersBuilder	builder(Set<String> scopes) Deprecated. This method was used for using cached tokens in client credentials or On-behalf-of flow. Those flows will now by default attempt to use cached the cached tokens, so there is no need to call acquireTokenSilently. This overload will be removed in the next major version.
static SilentParameters.SilentParametersBuilder	builder(Set<String> scopes, IAccount account) Builder for SilentParameters
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
boolean	forceRefresh() Force MSAL to refresh the tokens in the cache, even if there is a valid access token.
@NonNull Set<String>	scopes() Scopes application is requesting access to.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SilentParameters.SilentParametersBuilder builder(Set<String> scopes,
                                                               IAccount account)

Builder for SilentParameters

Parameters:

scopes - scopes application is requesting access to

account - IAccount for which to acquire a token for

Returns:

builder object that can be used to construct SilentParameters

builder

@Deprecated
public static SilentParameters.SilentParametersBuilder builder(Set<String> scopes)

Deprecated. This method was used for using cached tokens in client credentials or On-behalf-of flow. Those flows will now by default attempt to use cached the cached tokens, so there is no need to call acquireTokenSilently. This overload will be removed in the next major version.

Builder for SilentParameters

Parameters:

scopes - scopes application is requesting access to

Returns:

builder object that can be used to construct SilentParameters

scopes

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

Scopes application is requesting access to.

account

public IAccount account()

Account for which you are requesting a token for.

claims

public ClaimsRequest claims()

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

authorityUrl

public String authorityUrl()

Authority for which the application is requesting tokens from.

forceRefresh

public boolean forceRefresh()

Force MSAL to refresh the tokens in the cache, even if there is a valid access token.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Adds additional headers to the token request