com.microsoft.identity.client

Interface IMultipleAccountPublicClientApplication

All Superinterfaces:

IPublicClientApplication

All Known Implementing Classes:

MultipleAccountPublicClientApplication

public interface IMultipleAccountPublicClientApplication
extends IPublicClientApplication

An interface that contains list of operations that are available when MSAL is in 'multiple account' mode. - This mode allows an application to make API calls with more than one accounts. - The application will only be able to retrieve/remove accounts that have been used to acquire token interactively in this application - API calls' scope is limited to 'the calling app'. (i.e. removeAccount() will not remove credentials of the same account in other apps).

This is MSAL's default mode.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IMultipleAccountPublicClientApplication.GetAccountCallback
static interface	IMultipleAccountPublicClientApplication.RemoveAccountCallback

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

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

Method Summary

Modifier and Type	Method and Description
void	acquireToken(android.app.Activity activity, java.lang.String[] scopes, java.lang.String loginHint, AuthenticationCallback callback) Acquire token interactively, will pop-up webUI.
IAuthenticationResult	acquireTokenSilent(java.lang.String[] scopes, IAccount account, java.lang.String authority) Perform acquire token silent call.
void	acquireTokenSilentAsync(java.lang.String[] scopes, IAccount account, java.lang.String authority, SilentAuthenticationCallback callback) Perform acquire token silent call.
IAccount	getAccount(java.lang.String identifier) Retrieve the IAccount object matching the identifier.
void	getAccount(java.lang.String identifier, IMultipleAccountPublicClientApplication.GetAccountCallback callback) Retrieve the IAccount object matching the identifier.
java.util.List<IAccount>	getAccounts() Returns a List of IAccount objects for which this application has RefreshTokens.
void	getAccounts(IPublicClientApplication.LoadAccountsCallback callback) Asynchronously returns a List of IAccount objects for which this application has RefreshTokens.
boolean	removeAccount(IAccount account) Removes the Account and Credentials (tokens) for the supplied IAccount.
void	removeAccount(IAccount account, IMultipleAccountPublicClientApplication.RemoveAccountCallback callback) Removes the Account and Credentials (tokens) for the supplied IAccount.

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

acquireToken, acquireToken, acquireTokenSilent, acquireTokenSilentAsync, acquireTokenWithDeviceCode, generateSignedHttpRequest, generateSignedHttpRequest, getConfiguration, isSharedDevice

Method Detail

getAccounts

void getAccounts(IPublicClientApplication.LoadAccountsCallback callback)

Asynchronously returns a List of IAccount objects for which this application has RefreshTokens.

Parameters:

callback - The callback to notify once this action has finished.

getAccounts

java.util.List<IAccount> getAccounts()
                              throws java.lang.InterruptedException,
                                     MsalException

Returns a List of IAccount objects for which this application has RefreshTokens.

Throws:

java.lang.InterruptedException

MsalException

getAccount

void getAccount(java.lang.String identifier,
                IMultipleAccountPublicClientApplication.GetAccountCallback callback)

Retrieve the IAccount object matching the identifier. The identifier could be homeAccountIdentifier, localAccountIdentifier or username.

Parameters:

identifier - String of the identifier

callback - The callback to notify once this action has finished.

getAccount

IAccount getAccount(java.lang.String identifier)
             throws java.lang.InterruptedException,
                    MsalException

Retrieve the IAccount object matching the identifier. The identifier could be homeAccountIdentifier, localAccountIdentifier or username.

Parameters:

identifier - String of the identifier

Throws:

java.lang.InterruptedException

MsalException

removeAccount

void removeAccount(IAccount account,
                   IMultipleAccountPublicClientApplication.RemoveAccountCallback callback)

Removes the Account and Credentials (tokens) for the supplied IAccount.

Parameters:

account - The IAccount whose entry and associated tokens should be removed.

removeAccount

boolean removeAccount(IAccount account)
               throws MsalException,
                      java.lang.InterruptedException

Removes the Account and Credentials (tokens) for the supplied IAccount.

Parameters:

account - The IAccount whose entry and associated tokens should be removed.

Returns:

True, if the account was removed. False otherwise.

Throws:

MsalException

java.lang.InterruptedException

acquireToken

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

Acquire token interactively, will pop-up webUI. Interactive flow will skip the cache lookup.

Parameters:

activity - Non-null Activity that will be 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.

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

callback - The Non-null 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).

acquireTokenSilent

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

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.

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.

account - IAccount represents the account to silently request tokens for.

authority - Authority to issue the token.

Throws:

MsalException

java.lang.InterruptedException

acquireTokenSilentAsync

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

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.

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.

account - IAccount represents the account to silently request tokens for.

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 {