CustomAuthPublicClientApplication class

Creates a new instance of a PublicClientApplication with the given configuration and controller to start Native authentication flows

static function create(config: CustomAuthConfiguration): Promise<ICustomAuthPublicClientApplication>

Parameters

Returns

• A promise that resolves to a CustomAuthPublicClientApplication instance

Gets the current account from the browser cache.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parameters

Returns

• The result of the get account operation

Initiates the reset password flow. This method results in triggering extra action (submit code) to complete the reset password. Create result with error details if any exception thrown.

function resetPassword(resetPasswordInputs: ResetPasswordInputs): Promise<ResetPasswordStartResult>

Parameters

Returns

• A promise that resolves to ResetPasswordStartResult

Initiates the sign-in flow. This method results in sign-in completion, or extra actions (password, code, etc.) required to complete the sign-in. Create result with error details if any exception thrown.

function signIn(signInInputs: SignInInputs): Promise<SignInResult>

Parameters

Returns

• A promise that resolves to SignInResult

Initiates the sign-up flow. This method results in sign-up completion, or extra actions (password, code, etc.) required to complete the sign-up. Create result with error details if any exception thrown.

function signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>

Parameters

Returns

• A promise that resolves to SignUpResult

This function redeems an authorization code (passed as code) from the eSTS token endpoint. This authorization code should be acquired server-side using a confidential client to acquire a spa_code. This API is not indended for normal authorization code acquisition and redemption.

Redemption of this authorization code will not require PKCE, as it was acquired by a confidential client.

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

Parameters

Returns

A promise that is fulfilled when this function has completed, or rejected if an error was raised.

Inherited From PublicClientApplication.acquireTokenByCode

Use when you want to obtain an access_token for your API via opening a popup window in the user's browser

function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>

Parameters

Returns

A promise that is fulfilled when this function has completed, or rejected if an error was raised.

Inherited From PublicClientApplication.acquireTokenPopup

Use when you want to obtain an access_token for your API by redirecting the user's browser window to the authorization endpoint. This function redirects the page, so any code that follows this function will not execute.

IMPORTANT: It is NOT recommended to have code that is dependent on the resolution of the Promise. This function will navigate away from the current browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.

function acquireTokenRedirect(request: RedirectRequest): Promise<void>

Parameters

Returns

Inherited From PublicClientApplication.acquireTokenRedirect

Silently acquire an access token for a given set of scopes. Returns currently processing promise if parallel requests are made.

function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>

Parameters

Returns

• a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the AuthenticationResult object

Inherited From PublicClientApplication.acquireTokenSilent

Adds event callbacks to array

function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string

Parameters

Returns

Inherited From PublicClientApplication.addEventCallback

Registers a callback to receive performance events.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

Returns

Inherited From PublicClientApplication.addPerformanceCallback

Clears tokens and account from the browser cache.

function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>

Parameters

Returns

Inherited From PublicClientApplication.clearCache

Creates StandardController and passes it to the PublicClientApplication

static function createPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Parameters

Returns

Inherited From PublicClientApplication.createPublicClientApplication

Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window

function disableAccountStorageEvents()

Inherited From PublicClientApplication.disableAccountStorageEvents

Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window

function enableAccountStorageEvents()

Inherited From PublicClientApplication.enableAccountStorageEvents

Returns the first account found in the cache that matches the account filter passed in.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parameters

Returns

The first account found in the cache matching the provided filter or null if no account could be found.

Inherited From PublicClientApplication.getAccount

Returns the signed in account matching homeAccountId. (the account object is created at the time of successful login) or null when no matching account is found

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parameters

Returns

The account object stored in MSAL

Inherited From PublicClientApplication.getAccountByHomeId

Returns the signed in account matching localAccountId. (the account object is created at the time of successful login) or null when no matching account is found

function getAccountByLocalId(localId: string): null | AccountInfo

Parameters

Returns

The account object stored in MSAL

Inherited From PublicClientApplication.getAccountByLocalId

Returns the signed in account matching username. (the account object is created at the time of successful login) or null when no matching account is found. This API is provided for convenience but getAccountById should be used for best reliability

function getAccountByUsername(userName: string): null | AccountInfo

Parameters

Returns

The account object stored in MSAL

Inherited From PublicClientApplication.getAccountByUsername

Gets the currently active account

function getActiveAccount(): null | AccountInfo

Returns

Inherited From PublicClientApplication.getActiveAccount

Returns all the accounts in the cache that match the optional filter. If no filter is provided, all accounts are returned.

function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]

Parameters

Returns

Array of AccountInfo objects in cache

Inherited From PublicClientApplication.getAllAccounts

Returns the logger instance

function getLogger(): Logger

Returns

Inherited From PublicClientApplication.getLogger

Gets the token cache for the application.

function getTokenCache(): ITokenCache

Returns

Inherited From PublicClientApplication.getTokenCache

Event handler function which allows users to fire events after the PublicClientApplication object has loaded during redirect flows. This should be invoked on all page loads involved in redirect auth flows.

function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>

Parameters

Returns

Token response or null. If the return value is null, then no auth redirect was detected.

Inherited From PublicClientApplication.handleRedirectPromise

Hydrates cache with the tokens and account in the AuthenticationResult object

function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>

Parameters

Returns

Inherited From PublicClientApplication.hydrateCache

Initializer function to perform async startup tasks such as connecting to WAM extension

function initialize(request?: InitializeApplicationRequest): Promise<void>

Parameters

Returns

Inherited From PublicClientApplication.initialize

Called by wrapper libraries (Angular & React) to set SKU and Version passed down to telemetry, logger, etc.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parameters

Inherited From PublicClientApplication.initializeWrapperLibrary

Use when initiating the login process via opening a popup window in the user's browser

function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>

Parameters

Returns

A promise that is fulfilled when this function has completed, or rejected if an error was raised.

Inherited From PublicClientApplication.loginPopup

Use when initiating the login process by redirecting the user's browser to the authorization endpoint. This function redirects the page, so any code that follows this function will not execute.

IMPORTANT: It is NOT recommended to have code that is dependent on the resolution of the Promise. This function will navigate away from the current browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.

function loginRedirect(request?: RedirectRequest): Promise<void>

Parameters

Returns

Inherited From PublicClientApplication.loginRedirect

Deprecated logout function. Use logoutRedirect or logoutPopup instead

function logout(logoutRequest?: EndSessionRequest): Promise<void>

Parameters

Returns

Inherited From PublicClientApplication.logout

Clears local cache for the current user then opens a popup window prompting the user to sign-out of the server

function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>

Parameters

Returns

Inherited From PublicClientApplication.logoutPopup

Use to log out the current user, and redirect the user to the postLogoutRedirectUri. Default behaviour is to redirect the user to window.location.href.

function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>

Parameters

Returns

Inherited From PublicClientApplication.logoutRedirect

Removes callback with provided id from callback array

function removeEventCallback(callbackId: string)

Parameters

Inherited From PublicClientApplication.removeEventCallback

Removes a callback registered with addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parameters

Returns

Inherited From PublicClientApplication.removePerformanceCallback

Sets the account to use as the active account. If no account is passed to the acquireToken APIs, then MSAL will use this active account.

function setActiveAccount(account: null | AccountInfo)

Parameters

Inherited From PublicClientApplication.setActiveAccount

Replaces the default logger set in configurations with new Logger with new configurations

function setLogger(logger: Logger)

Parameters

Inherited From PublicClientApplication.setLogger

Sets navigation client

function setNavigationClient(navigationClient: INavigationClient)

Parameters

Inherited From PublicClientApplication.setNavigationClient

This function uses a hidden iframe to fetch an authorization code from the eSTS. There are cases where this may not work:

• Any browser using a form of Intelligent Tracking Prevention
• If there is not an established session with the service

In these cases, the request must be done inside a popup or full frame redirect.

For the cases where interaction is required, you cannot send a request with prompt=none.

If your refresh token has expired, you can use this function to fetch a new set of tokens silently as long as you session on the server still exists.

function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>

Parameters

Returns

A promise that is fulfilled when this function has completed, or rejected if an error was raised.

Inherited From PublicClientApplication.ssoSilent