com.microsoft.aad.msal4j

Interface IPublicClientApplication

All Superinterfaces:

IClientApplicationBase

All Known Implementing Classes:

PublicClientApplication

public interface IPublicClientApplication
extends IClientApplicationBase

Interface representing a public client application (Desktop, Mobile). Public client application are not trusted to safely store application secrets, and therefore can only request tokens in the name of an user. For details see https://aka.ms/msal4jclientapplications

Field Summary

Fields inherited from interface com.microsoft.aad.msal4j.IClientApplicationBase

DEFAULT_AUTHORITY

Method Summary

Modifier and Type	Method and Description
CompletableFuture<IAuthenticationResult>	acquireToken(DeviceCodeFlowParameters parameters) Acquires security token from the authority using an device code flow.
CompletableFuture<IAuthenticationResult>	acquireToken(IntegratedWindowsAuthenticationParameters parameters) Acquires tokens from the authority configured in the application via Integrated Windows Authentication.
CompletableFuture<IAuthenticationResult>	acquireToken(UserNamePasswordParameters parameters) Acquires tokens from the authority configured in the application via Username/Password authentication.

Methods inherited from interface com.microsoft.aad.msal4j.IClientApplicationBase

acquireToken, acquireToken, acquireTokenSilently, authority, clientId, correlationId, getAccounts, logPii, proxy, removeAccount, sslSocketFactory, telemetryConsumer, tokenCache, validateAuthority

Method Detail

acquireToken

CompletableFuture<IAuthenticationResult> acquireToken(UserNamePasswordParameters parameters)

Acquires tokens from the authority configured in the application via Username/Password authentication.

Parameters:

parameters - instance of UserNamePasswordParameters

Returns:

CompletableFuture containing an IAuthenticationResult

acquireToken

CompletableFuture<IAuthenticationResult> acquireToken(IntegratedWindowsAuthenticationParameters parameters)

Acquires tokens from the authority configured in the application via Integrated Windows Authentication.

Parameters:

parameters - instance of IntegratedWindowsAuthenticationParameters

Returns:

CompletableFuture containing an IAuthenticationResult

acquireToken

CompletableFuture<IAuthenticationResult> acquireToken(DeviceCodeFlowParameters parameters)

Acquires security token from the authority using an device code flow. Flow is designed for devices that do not have access to a browser or have input constraints. The authorization server issues DeviceCode object with verification code, an end-user code and the end-user verification URI. DeviceCode is provided through deviceCodeConsumer callback. End-user should be instructed to use another device to connect to the authorization server to approve the access request. Since the client cannot receive incoming requests, it polls the authorization server repeatedly until the end-user completes the approval process.

Parameters:

parameters - instance of DeviceCodeFlowParameters

Returns:

CompletableFuture containing an IAuthenticationResult

Throws:

MsalException - thrown if authorization is pending or another error occurred. If the errorCode of the exception is AuthenticationErrorCode.AUTHORIZATION_PENDING, the call needs to be retried until the AccessToken is returned. DeviceCode.interval - The minimum amount of time in seconds that the client SHOULD wait between polling requests to the token endpoint