com.microsoft.identity.client

Interface IPublicClientApplication

All Known Subinterfaces:

IMultipleAccountPublicClientApplication, ISingleAccountPublicClientApplication

All Known Implementing Classes:

MultipleAccountPublicClientApplication, PublicClientApplication, SingleAccountPublicClientApplication

public interface IPublicClientApplication

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IPublicClientApplication.ApplicationCreatedListener Listener callback for asynchronous initialization of IPublicClientApplication object.
static interface	IPublicClientApplication.DeviceCodeFlowCallback Callback object used in Device Code Flow.
static interface	IPublicClientApplication.IMultipleAccountApplicationCreatedListener Listener callback for asynchronous initialization of IMultipleAccountPublicClientApplication object.
static interface	IPublicClientApplication.ISingleAccountApplicationCreatedListener Listener callback for asynchronous initialization of ISingleAccountPublicClientApplication object.
static interface	IPublicClientApplication.LoadAccountsCallback
static interface	IPublicClientApplication.SignedHttpRequestRequestCallback Callback used to receive the result of generateSignedHttpRequest(IAccount, PoPAuthenticationScheme).

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.
void	acquireTokenSilentAsync(AcquireTokenSilentParameters acquireTokenSilentParameters) Perform acquire token silent call.
void	acquireTokenWithDeviceCode(java.lang.String[] scopes, IPublicClientApplication.DeviceCodeFlowCallback callback) Perform the Device Code Flow (DCF) protocol to allow a device without input capability to authenticate and get a new access token.
java.lang.String	generateSignedHttpRequest(IAccount account, PoPAuthenticationScheme popParameters) Signs the provided PoPAuthenticationScheme parameters into a JWT on behalf of the provided IAccount.
void	generateSignedHttpRequest(IAccount account, PoPAuthenticationScheme popParameters, IPublicClientApplication.SignedHttpRequestRequestCallback callback) Signs the provided PoPAuthenticationScheme parameters into a JWT on behalf of the provided IAccount.
PublicClientApplicationConfiguration	getConfiguration() Returns the PublicClientConfiguration for this instance of PublicClientApplication.
boolean	isSharedDevice() Returns whether the application is being run on a device that is marked as a shared.

Method Detail

acquireToken

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

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

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

void acquireToken(AcquireTokenParameters acquireTokenParameters)

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

Parameters:

acquireTokenParameters -

acquireTokenSilentAsync

void acquireTokenSilentAsync(AcquireTokenSilentParameters acquireTokenSilentParameters)

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:

acquireTokenSilentParameters -

acquireTokenSilent

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

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:

acquireTokenSilentParameters -

Throws:

java.lang.InterruptedException

MsalException

acquireTokenWithDeviceCode

void acquireTokenWithDeviceCode(java.lang.String[] scopes,
                                IPublicClientApplication.DeviceCodeFlowCallback callback)

Perform the Device Code Flow (DCF) protocol to allow a device without input capability to authenticate and get a new access token. Currently, flow is only supported in local MSAL. No Broker support.

Parameters:

scopes - the desired access scopes

callback - callback object used to communicate with the API throughout the protocol

getConfiguration

PublicClientApplicationConfiguration getConfiguration()

Returns the PublicClientConfiguration for this instance of PublicClientApplication.

Returns:

The PublicClientApplicationConfiguration.

isSharedDevice

boolean isSharedDevice()

Returns whether the application is being run on a device that is marked as a shared. Only SingleAccountPublicClientApplications may be used on shared devices

Returns:

generateSignedHttpRequest

java.lang.String generateSignedHttpRequest(IAccount account,
                                           PoPAuthenticationScheme popParameters)
                                    throws MsalException

Signs the provided PoPAuthenticationScheme parameters into a JWT on behalf of the provided IAccount.

Important: Use of this API requires setting the minimum_required_broker_protocol_version to "6.0" or higher.

Parameters:

account - The account for whom signing shall occur.

popParameters - The input parameters.

Returns:

The resulting SHR.

Throws:

MsalException

generateSignedHttpRequest

void generateSignedHttpRequest(IAccount account,
                               PoPAuthenticationScheme popParameters,
                               IPublicClientApplication.SignedHttpRequestRequestCallback callback)

Signs the provided PoPAuthenticationScheme parameters into a JWT on behalf of the provided IAccount.

Important: Use of this API requires setting the minimum_required_broker_protocol_version to "6.0" or higher.

Parameters:

account - The account for whom signing shall occur.

popParameters - The input parameters.

callback - The callback object to receive the result (or error).