Edit

Share via


ICustomAuthPublicClientApplication interface

Extends

IPublicClientApplication

Methods

getCurrentAccount(CustomAuthActionInputs)

Gets the current account from the cache.

resetPassword(ResetPasswordInputs)

Initiates the reset password flow.

signIn(SignInInputs)

Initiates the sign-in flow.

signUp(SignUpInputs)

Initiates the sign-up flow.

Inherited 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

getCurrentAccount(CustomAuthActionInputs)

Gets the current account from the cache.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parameters

accountRetrievalInputs

CustomAuthActionInputs

Inputs for getting the current cached account

Returns

The result of the operation

resetPassword(ResetPasswordInputs)

Initiates the reset password flow.

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

Parameters

resetPasswordInputs
ResetPasswordInputs

Inputs for the reset password flow

Returns

A promise that resolves to ResetPasswordStartResult

signIn(SignInInputs)

Initiates the sign-in flow.

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

Parameters

signInInputs
SignInInputs

Inputs for the sign-in flow

Returns

Promise<SignInResult>

A promise that resolves to SignInResult

signUp(SignUpInputs)

Initiates the sign-up flow.

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

Parameters

signUpInputs
SignUpInputs

Inputs for the sign-up flow

Returns

Promise<SignUpResult>

A promise that resolves to SignUpResult

Inherited Method Details

acquireTokenByCode(AuthorizationCodeRequest)

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

Parameters

request

AuthorizationCodeRequest

Returns

Promise<AuthenticationResult>

Inherited From IPublicClientApplication.acquireTokenByCode

acquireTokenPopup(PopupRequest)

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

Parameters

request

PopupRequest

Returns

Promise<AuthenticationResult>

Inherited From IPublicClientApplication.acquireTokenPopup

acquireTokenRedirect(RedirectRequest)

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

Parameters

request

RedirectRequest

Returns

Promise<void>

Inherited From IPublicClientApplication.acquireTokenRedirect

acquireTokenSilent(SilentRequest)

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

Parameters

silentRequest

SilentRequest

Returns

Promise<AuthenticationResult>

Inherited From IPublicClientApplication.acquireTokenSilent

addEventCallback(EventCallbackFunction, EventType[])

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

Parameters

callback

EventCallbackFunction

eventTypes

EventType[]

Returns

null | string

Inherited From IPublicClientApplication.addEventCallback

addPerformanceCallback(PerformanceCallbackFunction)

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

Returns

string

Inherited From IPublicClientApplication.addPerformanceCallback

clearCache(ClearCacheRequest)

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

Parameters

logoutRequest

ClearCacheRequest

Returns

Promise<void>

Inherited From IPublicClientApplication.clearCache

disableAccountStorageEvents()

function disableAccountStorageEvents()

Inherited From IPublicClientApplication.disableAccountStorageEvents

enableAccountStorageEvents()

function enableAccountStorageEvents()

Inherited From IPublicClientApplication.enableAccountStorageEvents

getAccount(AccountFilter)

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parameters

accountFilter
@azure/msal-common.AccountFilter

Returns

null | AccountInfo

Inherited From IPublicClientApplication.getAccount

getAccountByHomeId(string)

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parameters

homeAccountId

string

Returns

null | AccountInfo

Inherited From IPublicClientApplication.getAccountByHomeId

getAccountByLocalId(string)

function getAccountByLocalId(localId: string): null | AccountInfo

Parameters

localId

string

Returns

null | AccountInfo

Inherited From IPublicClientApplication.getAccountByLocalId

getAccountByUsername(string)

function getAccountByUsername(userName: string): null | AccountInfo

Parameters

userName

string

Returns

null | AccountInfo

Inherited From IPublicClientApplication.getAccountByUsername

getActiveAccount()

function getActiveAccount(): null | AccountInfo

Returns

null | AccountInfo

Inherited From IPublicClientApplication.getActiveAccount

getAllAccounts()

function getAllAccounts(): AccountInfo[]

Returns

Inherited From IPublicClientApplication.getAllAccounts

getLogger()

function getLogger(): Logger

Returns

Inherited From IPublicClientApplication.getLogger

getTokenCache()

function getTokenCache(): ITokenCache

Returns

ITokenCache

Inherited From IPublicClientApplication.getTokenCache

handleRedirectPromise(string)

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

Parameters

hash

string

Returns

Promise<null | AuthenticationResult>

Inherited From IPublicClientApplication.handleRedirectPromise

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>

Inherited From IPublicClientApplication.hydrateCache

initialize(InitializeApplicationRequest)

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

Parameters

request

InitializeApplicationRequest

Returns

Promise<void>

Inherited From IPublicClientApplication.initialize

initializeWrapperLibrary(WrapperSKU, string)

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parameters

sku

WrapperSKU

version

string

Inherited From IPublicClientApplication.initializeWrapperLibrary

loginPopup(PopupRequest)

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

Parameters

request

PopupRequest

Returns

Promise<AuthenticationResult>

Inherited From IPublicClientApplication.loginPopup

loginRedirect(RedirectRequest)

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

Parameters

request

RedirectRequest

Returns

Promise<void>

Inherited From IPublicClientApplication.loginRedirect

logout(EndSessionRequest)

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

Parameters

logoutRequest

EndSessionRequest

Returns

Promise<void>

Inherited From IPublicClientApplication.logout

logoutPopup(EndSessionPopupRequest)

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

Parameters

logoutRequest

EndSessionPopupRequest

Returns

Promise<void>

Inherited From IPublicClientApplication.logoutPopup

logoutRedirect(EndSessionRequest)

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

Parameters

logoutRequest

EndSessionRequest

Returns

Promise<void>

Inherited From IPublicClientApplication.logoutRedirect

removeEventCallback(string)

function removeEventCallback(callbackId: string)

Parameters

callbackId

string

Inherited From IPublicClientApplication.removeEventCallback

removePerformanceCallback(string)

function removePerformanceCallback(callbackId: string): boolean

Parameters

callbackId

string

Returns

boolean

Inherited From IPublicClientApplication.removePerformanceCallback

setActiveAccount(null | AccountInfo)

function setActiveAccount(account: null | AccountInfo)

Parameters

account

null | AccountInfo

Inherited From IPublicClientApplication.setActiveAccount

setLogger(Logger)

function setLogger(logger: Logger)

Parameters

logger
Logger

Inherited From IPublicClientApplication.setLogger

setNavigationClient(INavigationClient)

function setNavigationClient(navigationClient: INavigationClient)

Parameters

navigationClient

INavigationClient

Inherited From IPublicClientApplication.setNavigationClient

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>

Inherited From IPublicClientApplication.ssoSilent