Edit

Share via

IPublicClientApplication interface

Package:
@azure/msal-browser

Methods

acquireTokenByCode(AuthorizationCodeRequest)
acquireTokenPopup(PopupRequest)
acquireTokenRedirect(RedirectRequest)
acquireTokenSilent(SilentRequest)
addEventCallback(EventCallbackFunction, EventType[])
addPerformanceCallback(PerformanceCallbackFunction)
clearCache(ClearCacheRequest)
disableAccountStorageEvents()
enableAccountStorageEvents()
getAccount(AccountFilter)
getAccountByHomeId(string)
getAccountByLocalId(string)
getAccountByUsername(string)
getActiveAccount()
getAllAccounts()
getLogger()
getTokenCache()
handleRedirectPromise(string)
hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)
initialize(InitializeApplicationRequest)
initializeWrapperLibrary(WrapperSKU, string)
loginPopup(PopupRequest)
loginRedirect(RedirectRequest)
logout(EndSessionRequest)
logoutPopup(EndSessionPopupRequest)
logoutRedirect(EndSessionRequest)
removeEventCallback(string)
removePerformanceCallback(string)
setActiveAccount(null | AccountInfo)
setLogger(Logger)
setNavigationClient(INavigationClient)
ssoSilent(Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)

Method Details

acquireTokenByCode(AuthorizationCodeRequest) 

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

Parameters

request
AuthorizationCodeRequest

Returns

Promise<AuthenticationResult>

acquireTokenPopup(PopupRequest) 

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

Parameters

request
PopupRequest

Returns

Promise<AuthenticationResult>

acquireTokenRedirect(RedirectRequest) 

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

Parameters

request
RedirectRequest

Returns

Promise<void>

acquireTokenSilent(SilentRequest) 

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

Parameters

silentRequest
SilentRequest

Returns

Promise<AuthenticationResult>

addEventCallback(EventCallbackFunction, EventType[]) 

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

Parameters

callback
EventCallbackFunction
eventTypes

EventType[]

Returns

null | string

addPerformanceCallback(PerformanceCallbackFunction) 

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

callback
PerformanceCallbackFunction

Returns

string

clearCache(ClearCacheRequest) 

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

Parameters

logoutRequest
ClearCacheRequest

Returns

Promise<void>

disableAccountStorageEvents() 

function disableAccountStorageEvents()

enableAccountStorageEvents() 

function enableAccountStorageEvents()

getAccount(AccountFilter) 

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parameters

accountFilter
@azure/msal-common.AccountFilter

Returns

null | AccountInfo

getAccountByHomeId(string) 

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parameters

homeAccountId

string

Returns

null | AccountInfo

getAccountByLocalId(string) 

function getAccountByLocalId(localId: string): null | AccountInfo

Parameters

localId

string

Returns

null | AccountInfo

getAccountByUsername(string) 

function getAccountByUsername(userName: string): null | AccountInfo

Parameters

userName

string

Returns

null | AccountInfo

getActiveAccount() 

function getActiveAccount(): null | AccountInfo

Returns

null | AccountInfo

getAllAccounts() 

function getAllAccounts(): AccountInfo[]

Returns

AccountInfo[]

getLogger() 

function getLogger(): Logger

Returns

Logger

getTokenCache() 

function getTokenCache(): ITokenCache

Returns

ITokenCache

handleRedirectPromise(string) 

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

Parameters

hash

string

Returns

Promise<null | AuthenticationResult>

hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>) 

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

Parameters

result
AuthenticationResult
request

PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<@azure/msal-common.CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>

Returns

Promise<void>

initialize(InitializeApplicationRequest) 

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

Parameters

request
InitializeApplicationRequest

Returns

Promise<void>

initializeWrapperLibrary(WrapperSKU, string) 

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parameters

sku

WrapperSKU

version

string

loginPopup(PopupRequest) 

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

Parameters

request
PopupRequest

Returns

Promise<AuthenticationResult>

loginRedirect(RedirectRequest) 

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

Parameters

request
RedirectRequest

Returns

Promise<void>

logout(EndSessionRequest) 

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

Parameters

logoutRequest
EndSessionRequest

Returns

Promise<void>

logoutPopup(EndSessionPopupRequest) 

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

Parameters

logoutRequest
EndSessionPopupRequest

Returns

Promise<void>

logoutRedirect(EndSessionRequest) 

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

Parameters

logoutRequest
EndSessionRequest

Returns

Promise<void>

removeEventCallback(string) 

function removeEventCallback(callbackId: string)

Parameters

callbackId

string

removePerformanceCallback(string) 

function removePerformanceCallback(callbackId: string): boolean

Parameters

callbackId

string

Returns

boolean

setActiveAccount(null | AccountInfo) 

function setActiveAccount(account: null | AccountInfo)

Parameters

account

null | AccountInfo

setLogger(Logger) 

function setLogger(logger: Logger)

Parameters

logger
Logger

setNavigationClient(INavigationClient) 

function setNavigationClient(navigationClient: INavigationClient)

Parameters

navigationClient
INavigationClient

ssoSilent(Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>) 

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

Parameters

request

Partial<Omit<@azure/msal-common.CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>

Returns

Promise<AuthenticationResult>