com.microsoft.aad.msal4j

Class RefreshTokenParameters

java.lang.Object

com.microsoft.aad.msal4j.RefreshTokenParameters

public class RefreshTokenParameters
extends Object

Object containing parameters for refresh token request. Can be used as parameter to AbstractClientApplicationBase.acquireToken(RefreshTokenParameters) or to AbstractClientApplicationBase.acquireToken(RefreshTokenParameters)

RefreshTokenParameters should only be used for migration scenarios (when moving from ADAL to MSAL). To acquire tokens silently, use AbstractClientApplicationBase.acquireTokenSilently(SilentParameters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RefreshTokenParameters.RefreshTokenParametersBuilder

Method Summary

Modifier and Type	Method and Description
static RefreshTokenParameters.RefreshTokenParametersBuilder	builder(Set<String> scopes, String refreshToken) Builder for RefreshTokenParameters
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 String	refreshToken() Refresh token received from the STS
@NonNull Set<String>	scopes() Scopes the application is requesting access to
String	tenant() Overrides the tenant value in the authority URL for this request

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static RefreshTokenParameters.RefreshTokenParametersBuilder builder(Set<String> scopes,
                                                                           String refreshToken)

Builder for RefreshTokenParameters

Parameters:

scopes - scopes application is requesting access to

refreshToken - refresh token received form the STS

Returns:

builder object that can be used to construct RefreshTokenParameters

scopes

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

Scopes the application is requesting access to

refreshToken

@NonNull
public @NonNull String refreshToken()

Refresh token received from the STS

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