com.microsoft.identity.client

Class SingleAccountPublicClientApplication

java.lang.Object

com.microsoft.identity.client.PublicClientApplication

com.microsoft.identity.client.SingleAccountPublicClientApplication

All Implemented Interfaces:

IPublicClientApplication, ISingleAccountPublicClientApplication, ITokenShare

public class SingleAccountPublicClientApplication
extends PublicClientApplication
implements ISingleAccountPublicClientApplication

Nested Class Summary

Nested classes/interfaces inherited from class com.microsoft.identity.client.PublicClientApplication

PublicClientApplication.BrokerDeviceModeCallback

Nested classes/interfaces inherited from interface com.microsoft.identity.client.ISingleAccountPublicClientApplication

ISingleAccountPublicClientApplication.CurrentAccountCallback, ISingleAccountPublicClientApplication.SignOutCallback

Nested classes/interfaces inherited from interface com.microsoft.identity.client.IPublicClientApplication

IPublicClientApplication.ApplicationCreatedListener, IPublicClientApplication.DeviceCodeFlowCallback, IPublicClientApplication.IMultipleAccountApplicationCreatedListener, IPublicClientApplication.ISingleAccountApplicationCreatedListener, IPublicClientApplication.LoadAccountsCallback, IPublicClientApplication.SignedHttpRequestRequestCallback

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENT_ACCOUNT_SHARED_PREFERENCE_KEY SharedPreference key for storing current account.
static java.lang.String	SINGLE_ACCOUNT_CREDENTIAL_SHARED_PREFERENCES Name of the shared preference cache for storing SingleAccountPublicClientApplication data.

Method Summary

Modifier and Type	Method and Description
void	acquireToken(AcquireTokenParameters acquireTokenParameters) Acquire token interactively, will pop-up webUI.
void	acquireToken(android.app.Activity activity, java.lang.String[] scopes, AuthenticationCallback callback) Acquire token interactively, will pop-up webUI.
IAuthenticationResult	acquireTokenSilent(AcquireTokenSilentParameters acquireTokenSilentParameters) Perform acquire token silent call.
IAuthenticationResult	acquireTokenSilent(java.lang.String[] scopes, java.lang.String authority) Perform acquire token silent call.
void	acquireTokenSilentAsync(AcquireTokenSilentParameters acquireTokenSilentParameters) Perform acquire token silent call.
void	acquireTokenSilentAsync(java.lang.String[] scopes, java.lang.String authority, SilentAuthenticationCallback callback) Perform acquire token silent call.
ICurrentAccountResult	getCurrentAccount() Gets the current account and notify if the current account changes.
void	getCurrentAccountAsync(ISingleAccountPublicClientApplication.CurrentAccountCallback callback) Gets the current account and notify if the current account changes.
void	signIn(android.app.Activity activity, java.lang.String loginHint, java.lang.String[] scopes, AuthenticationCallback callback) Allows a user to sign in to your application with one of their accounts.
void	signIn(android.app.Activity activity, java.lang.String loginHint, java.lang.String[] scopes, Prompt prompt, AuthenticationCallback callback) Allows a user to sign in to your application with one of their accounts.
void	signInAgain(android.app.Activity activity, java.lang.String[] scopes, Prompt prompt, AuthenticationCallback callback) Reauthorizes the current account according to the supplied scopes and prompt behavior.
boolean	signOut() Signs out the current the Account and Credentials (tokens).
void	signOut(ISingleAccountPublicClientApplication.SignOutCallback callback) Signs out the current the Account and Credentials (tokens).

Methods inherited from class com.microsoft.identity.client.PublicClientApplication

acquireTokenWithDeviceCode, create, create, create, create, createMultipleAccountPublicClientApplication, createMultipleAccountPublicClientApplication, createMultipleAccountPublicClientApplication, createMultipleAccountPublicClientApplication, createSingleAccountPublicClientApplication, createSingleAccountPublicClientApplication, createSingleAccountPublicClientApplication, createSingleAccountPublicClientApplication, generateSignedHttpRequest, generateSignedHttpRequest, getConfiguration, getMsaFamilyRefreshToken, getMsaFamilyRefreshTokenWithMetadata, getOrgIdFamilyRefreshToken, getOrgIdFamilyRefreshTokenWithMetadata, getSdkVersion, isSharedDevice, saveMsaFamilyRefreshToken, saveOrgIdFamilyRefreshToken, showExpectedMsalRedirectUriInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.identity.client.IPublicClientApplication

acquireTokenWithDeviceCode, generateSignedHttpRequest, generateSignedHttpRequest, getConfiguration, isSharedDevice

Field Detail

SINGLE_ACCOUNT_CREDENTIAL_SHARED_PREFERENCES

public static final java.lang.String SINGLE_ACCOUNT_CREDENTIAL_SHARED_PREFERENCES

Name of the shared preference cache for storing SingleAccountPublicClientApplication data.

See Also:

Constant Field Values

CURRENT_ACCOUNT_SHARED_PREFERENCE_KEY

public static final java.lang.String CURRENT_ACCOUNT_SHARED_PREFERENCE_KEY

SharedPreference key for storing current account.

See Also:

Constant Field Values

Method Detail

getCurrentAccountAsync

public void getCurrentAccountAsync(ISingleAccountPublicClientApplication.CurrentAccountCallback callback)

Description copied from interface: ISingleAccountPublicClientApplication

Gets the current account and notify if the current account changes. This method must be called whenever the application is resumed or prior to running a scheduled background operation.

Specified by:

getCurrentAccountAsync in interface ISingleAccountPublicClientApplication

Parameters:

callback - a callback to be invoked when the operation finishes.

getCurrentAccount

public ICurrentAccountResult getCurrentAccount()
                                        throws java.lang.InterruptedException,
                                               MsalException

Description copied from interface: ISingleAccountPublicClientApplication

Gets the current account and notify if the current account changes. This method must be called whenever the application is resumed or prior to running a scheduled background operation.

Specified by:

getCurrentAccount in interface ISingleAccountPublicClientApplication

Returns:

CurrentAccountResult

Throws:

java.lang.InterruptedException

MsalException

signIn

public void signIn(android.app.Activity activity,
                   java.lang.String loginHint,
                   java.lang.String[] scopes,
                   AuthenticationCallback callback)

Description copied from interface: ISingleAccountPublicClientApplication

Allows a user to sign in to your application with one of their accounts. This method may only be called once: once a user is signed in, they must first be signed out before another user may sign in. If you wish to prompt the existing user for credentials use ISingleAccountPublicClientApplication.signInAgain(Activity, String[], Prompt, AuthenticationCallback) or IPublicClientApplication.acquireToken(AcquireTokenParameters).

Note: The authority used to make the sign in request will be either the MSAL default: https://login.microsoftonline.com/common or the default authority specified by you in your configuration

Specified by:

signIn in interface ISingleAccountPublicClientApplication

Parameters:

activity - Non-null Activity that is used as the parent activity for launching the com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity.

loginHint - Optional. If provided, will be used as the query parameter sent for authenticating the user, which will have the UPN pre-populated.

scopes - The non-null array of scopes to be consented to during sign in. MSAL always sends the scopes 'openid profile offline_access'. Do not include any of these scopes in the scope parameter. The access token returned is for MS Graph and will allow you to query for additional information about the signed in account.

callback - AuthenticationCallback that is used to send the result back. The success result will be sent back via SilentAuthenticationCallback.onSuccess(IAuthenticationResult). Failure case will be sent back via {

signIn

public void signIn(android.app.Activity activity,
                   java.lang.String loginHint,
                   java.lang.String[] scopes,
                   Prompt prompt,
                   AuthenticationCallback callback)

Description copied from interface: ISingleAccountPublicClientApplication

Allows a user to sign in to your application with one of their accounts. This method may only be called once: once a user is signed in, they must first be signed out before another user may sign in. If you wish to prompt the existing user for credentials use ISingleAccountPublicClientApplication.signInAgain(Activity, String[], Prompt, AuthenticationCallback) or IPublicClientApplication.acquireToken(AcquireTokenParameters).

Note: The authority used to make the sign in request will be either the MSAL default: https://login.microsoftonline.com/common or the default authority specified by you in your configuration

Specified by:

signIn in interface ISingleAccountPublicClientApplication

Parameters:

activity - Non-null Activity that is used as the parent activity for launching the com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity.

loginHint - Optional. If provided, will be used as the query parameter sent for authenticating the user, which will have the UPN pre-populated.

scopes - The non-null array of scopes to be consented to during sign in. MSAL always sends the scopes 'openid profile offline_access'. Do not include any of these scopes in the scope parameter. The access token returned is for MS Graph and will allow you to query for additional information about the signed in account.

callback - AuthenticationCallback that is used to send the result back. The success result will be sent back via SilentAuthenticationCallback.onSuccess(IAuthenticationResult). Failure case will be sent back via {

signInAgain

public void signInAgain(android.app.Activity activity,
                        java.lang.String[] scopes,
                        Prompt prompt,
                        AuthenticationCallback callback)

Description copied from interface: ISingleAccountPublicClientApplication

Reauthorizes the current account according to the supplied scopes and prompt behavior.

Note: The authority used to make the sign in request will be either the MSAL default: https://login.microsoftonline.com/common or the default authority specified by you in your configuration.

Specified by:

signInAgain in interface ISingleAccountPublicClientApplication

Parameters:

activity - Non-null Activity that is used as the parent activity for launching the com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity.

scopes - The non-null array of scopes to be consented to during sign in. MSAL always sends the scopes 'openid profile offline_access'. Do not include any of these scopes in the scope parameter. The access token returned is for MS Graph and will allow you to query for additional information about the signed in account.

prompt - Nullable. Indicates the type of user interaction that is required. If no argument is supplied the default behavior will be used.

callback - AuthenticationCallback that is used to send the result back. The success result will be sent back via SilentAuthenticationCallback.onSuccess(IAuthenticationResult). Failure case will be sent back via SilentAuthenticationCallback.onError(MsalException).

signOut

public void signOut(ISingleAccountPublicClientApplication.SignOutCallback callback)

Description copied from interface: ISingleAccountPublicClientApplication

Signs out the current the Account and Credentials (tokens). NOTE: If a device is marked as a shared device within broker signout will be device wide.

Specified by:

signOut in interface ISingleAccountPublicClientApplication

Parameters:

callback - a callback to be invoked when the operation finishes.

signOut

public boolean signOut()
                throws MsalException,
                       java.lang.InterruptedException

Description copied from interface: ISingleAccountPublicClientApplication

Signs out the current the Account and Credentials (tokens). NOTE: If a device is marked as a shared device within broker signout will be device wide.

Specified by:

signOut in interface ISingleAccountPublicClientApplication

Returns:

boolean indicating whether the account was removed successfully

Throws:

MsalException

java.lang.InterruptedException

acquireToken

public void acquireToken(android.app.Activity activity,
                         java.lang.String[] scopes,
                         AuthenticationCallback callback)

Description copied from interface: IPublicClientApplication

Acquire token interactively, will pop-up webUI. Interactive flow will skip the cache lookup. Default value for Prompt is Prompt.SELECT_ACCOUNT.

Specified by:

acquireToken in interface IPublicClientApplication

Overrides:

acquireToken in class PublicClientApplication

Parameters:

activity - Non-null Activity that is used as the parent activity for launching the com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity.

scopes - 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.

callback - The AuthenticationCallback to receive the result back. 1) If user cancels the flow by pressing the device back button, the result will be sent back via AuthenticationCallback.onCancel(). 2) If the sdk successfully receives the token back, result will be sent back via SilentAuthenticationCallback.onSuccess(IAuthenticationResult) 3) All the other errors will be sent back via SilentAuthenticationCallback.onError(MsalException).

acquireToken

public void acquireToken(AcquireTokenParameters acquireTokenParameters)

Description copied from interface: IPublicClientApplication

Acquire token interactively, will pop-up webUI. Interactive flow will skip the cache lookup. Default value for Prompt is Prompt.SELECT_ACCOUNT.

Convey parameters via the AquireTokenParameters object

Specified by:

acquireToken in interface IPublicClientApplication

Overrides:

acquireToken in class PublicClientApplication

acquireTokenSilentAsync

public void acquireTokenSilentAsync(java.lang.String[] scopes,
                                    java.lang.String authority,
                                    SilentAuthenticationCallback callback)

Description copied from interface: ISingleAccountPublicClientApplication

Perform acquire token silent call. If there is a valid access token in the cache, the sdk will return the access token; If no valid access token exists, the sdk will try to find a refresh token and use the refresh token to get a new access token. If refresh token does not exist or it fails the refresh, exception will be sent back via callback.

Specified by:

acquireTokenSilentAsync in interface ISingleAccountPublicClientApplication

Parameters:

scopes - 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.

authority - Authority to issue the token.

callback - SilentAuthenticationCallback that is used to send the result back. The success result will be sent back via SilentAuthenticationCallback.onSuccess(IAuthenticationResult). Failure case will be sent back via {

acquireTokenSilent

public IAuthenticationResult acquireTokenSilent(java.lang.String[] scopes,
                                                java.lang.String authority)
                                         throws MsalException,
                                                java.lang.InterruptedException

Description copied from interface: ISingleAccountPublicClientApplication

Perform acquire token silent call. If there is a valid access token in the cache, the sdk will return the access token; If no valid access token exists, the sdk will try to find a refresh token and use the refresh token to get a new access token. If refresh token does not exist or it fails the refresh, exception will be sent back via callback.

Specified by:

acquireTokenSilent in interface ISingleAccountPublicClientApplication

Parameters:

scopes - 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.

authority - Authority to issue the token.

Throws:

MsalException

java.lang.InterruptedException

acquireTokenSilentAsync

public void acquireTokenSilentAsync(AcquireTokenSilentParameters acquireTokenSilentParameters)

Description copied from interface: IPublicClientApplication

Perform acquire token silent call. If there is a valid access token in the cache, the sdk will return the access token; If no valid access token exists, the sdk will try to find a refresh token and use the refresh token to get a new access token. If refresh token does not exist or it fails the refresh, exception will be sent back via callback.

Specified by:

acquireTokenSilentAsync in interface IPublicClientApplication

Overrides:

acquireTokenSilentAsync in class PublicClientApplication

acquireTokenSilent

public IAuthenticationResult acquireTokenSilent(AcquireTokenSilentParameters acquireTokenSilentParameters)
                                         throws java.lang.InterruptedException,
                                                MsalException

Description copied from interface: IPublicClientApplication

Perform acquire token silent call. If there is a valid access token in the cache, the sdk will return the access token; If no valid access token exists, the sdk will try to find a refresh token and use the refresh token to get a new access token. If refresh token does not exist or it fails the refresh, exception will be sent back via callback.

Specified by:

acquireTokenSilent in interface IPublicClientApplication

Overrides:

acquireTokenSilent in class PublicClientApplication

Throws:

java.lang.InterruptedException

MsalException