com.microsoft.identity.client

Class TokenParameters

java.lang.Object

com.microsoft.identity.client.TokenParameters

Direct Known Subclasses:

AcquireTokenParameters, AcquireTokenSilentParameters

public abstract class TokenParameters
extends java.lang.Object

Base class for AcquireTokenParameters and AcquireTokenSilentParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenParameters.Builder<B extends TokenParameters.Builder<B>> TokenParameters builder

Method Summary

Modifier and Type	Method and Description
IAccount	getAccount() Optional.
AccountRecord	getAccountRecord()
AuthenticationScheme	getAuthenticationScheme() Gets the AuthenticationScheme.
java.lang.String	getAuthority() Optional.
ClaimsRequest	getClaimsRequest() Optional.
java.lang.String	getCorrelationId() Gets the correlation id passed to Token Parameters.
java.util.List<java.lang.String>	getScopes() The non-null array of scopes to be requested for the access token.

Methods inherited from class java.lang.Object

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

Method Detail

getAuthenticationScheme

public AuthenticationScheme getAuthenticationScheme()

Gets the AuthenticationScheme.

Returns:

The AuthenticationScheme to get.

getScopes

public java.util.List<java.lang.String> getScopes()

The non-null array of scopes to be requested for the access token. MSAL always sends the scopes 'openid profile offline_access'. Do not include any of these scopes in the scope parameter.

Returns:

getAccount

public IAccount getAccount()

Optional. If provided, will be used to force the session continuation. If user tries to sign in with a different account, error will be returned.

Returns:

getAuthority

public java.lang.String getAuthority()

Optional. Can be passed to override the default authority.

Returns:

getClaimsRequest

public ClaimsRequest getClaimsRequest()

Optional. Can be passed into request specific claims in the id_token and access_token

Returns:

getAccountRecord

public AccountRecord getAccountRecord()

getCorrelationId

public java.lang.String getCorrelationId()

Gets the correlation id passed to Token Parameters. If specified, MSAL will use this correlation id for the request instead of generating a new one.

Returns:

a String representing the correlation id passed to TokenParameters