ICustomAuthPublicClientApplication interface

Пакет:

@azure/msal-browser

Extends

IPublicClientApplication

Методы

getCurrentAccount(CustomAuthActionInputs)	Возвращает текущую учетную запись из кэша.
resetPassword(ResetPasswordInputs)	Инициирует поток сброса пароля.
signIn(SignInInputs)	Инициирует поток входа.
signUp(SignUpInputs)	Инициирует поток регистрации.

Наследуемые методы

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">>)

Сведения о методе

getCurrentAccount(CustomAuthActionInputs)

Возвращает текущую учетную запись из кэша.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Параметры

accountRetrievalInputs

CustomAuthActionInputs

Входные данные для получения текущей кэшной учетной записи

Возвращаемое значение

GetAccountResult

Результат операции

resetPassword(ResetPasswordInputs)

Инициирует поток сброса пароля.

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

Параметры

resetPasswordInputs

ResetPasswordInputs

Входные данные для потока сброса пароля

Возвращаемое значение

Promise<ResetPasswordStartResult>

Обещание, которое разрешается в ResetPasswordStartResult

signIn(SignInInputs)

Инициирует поток входа.

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

Параметры

signInInputs

SignInInputs

Входные данные для потока входа

Возвращаемое значение

Promise<SignInResult>

Обещание, разрешающее signInResult

signUp(SignUpInputs)

Инициирует поток регистрации.

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

Параметры

signUpInputs

SignUpInputs

Входные данные для потока регистрации

Возвращаемое значение

Promise<SignUpResult>

Обещание, разрешающее signUpResult

Сведения о наследуемом методе

acquireTokenByCode(AuthorizationCodeRequest)

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

Параметры

request

AuthorizationCodeRequest

Возвращаемое значение

Promise<AuthenticationResult>

Наследуется от IPublicClientApplication.acquireTokenByCode

acquireTokenPopup(PopupRequest)

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

Параметры

request

PopupRequest

Возвращаемое значение

Promise<AuthenticationResult>

Наследуется от IPublicClientApplication.acquireTokenPopup

acquireTokenRedirect(RedirectRequest)

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

Параметры

request

RedirectRequest

Возвращаемое значение

Promise<void>

Наследуется от IPublicClientApplication.acquireTokenRedirect

acquireTokenSilent(SilentRequest)

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

Параметры

silentRequest

SilentRequest

Возвращаемое значение

Promise<AuthenticationResult>

Наследуется от IPublicClientApplication.acquireTokenSilent

addEventCallback(EventCallbackFunction, EventType[])

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

Параметры

callback

EventCallbackFunction

eventTypes

EventType[]

Возвращаемое значение

null | string

Наследуется от IPublicClientApplication.addEventCallback

addPerformanceCallback(PerformanceCallbackFunction)

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Параметры

callback

PerformanceCallbackFunction

Возвращаемое значение

string

Наследуется от IPublicClientApplication.addPerformanceCallback

clearCache(ClearCacheRequest)

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

Параметры

logoutRequest

ClearCacheRequest

Возвращаемое значение

Promise<void>

Наследуется от IPublicClientApplication.clearCache

disableAccountStorageEvents()

function disableAccountStorageEvents()

Наследуется от IPublicClientApplication.disableAccountStorageEvents

enableAccountStorageEvents()

function enableAccountStorageEvents()

Наследуется от IPublicClientApplication.enableAccountStorageEvents

getAccount(AccountFilter)

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Параметры

accountFilter

AccountFilter

Возвращаемое значение

null | AccountInfo

Наследуется от IPublicClientApplication.getAccount

getAccountByHomeId(string)

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Параметры

homeAccountId

string

Возвращаемое значение

null | AccountInfo

Наследуется от IPublicClientApplication.getAccountByHomeId

getAccountByLocalId(string)

function getAccountByLocalId(localId: string): null | AccountInfo

Параметры

localId

string

Возвращаемое значение

null | AccountInfo

Наследуется от IPublicClientApplication.getAccountByLocalId

getAccountByUsername(string)

function getAccountByUsername(userName: string): null | AccountInfo

Параметры

userName

string

Возвращаемое значение

null | AccountInfo

Наследуется от IPublicClientApplication.getAccountByUsername

getActiveAccount()

function getActiveAccount(): null | AccountInfo

Возвращаемое значение

null | AccountInfo

Наследуется от IPublicClientApplication.getActiveAccount

getAllAccounts()

function getAllAccounts(): AccountInfo[]

Возвращаемое значение

AccountInfo[]

Наследуется от IPublicClientApplication.getAllAccounts

getLogger()

function getLogger(): Logger

Возвращаемое значение

Logger

Наследуется от IPublicClientApplication.getLogger

getTokenCache()

function getTokenCache(): ITokenCache

Возвращаемое значение

ITokenCache

Наследуется от IPublicClientApplication.getTokenCache

handleRedirectPromise(string)

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

Параметры

hash

string

Возвращаемое значение

Promise<null | AuthenticationResult>

Наследуется от 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>

Параметры

result

AuthenticationResult

request

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

Возвращаемое значение

Promise<void>

Наследуется от IPublicClientApplication.hydrateCache

initialize(InitializeApplicationRequest)

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

Параметры

request

InitializeApplicationRequest

Возвращаемое значение

Promise<void>

Наследуется от IPublicClientApplication.initialize

initializeWrapperLibrary(WrapperSKU, string)

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Параметры

sku

WrapperSKU

version

string

Наследуется от IPublicClientApplication.initializeWrapperLibrary

loginPopup(PopupRequest)

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

Параметры

request

PopupRequest

Возвращаемое значение

Promise<AuthenticationResult>

Наследуется от IPublicClientApplication.loginPopup

loginRedirect(RedirectRequest)

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

Параметры

request

RedirectRequest

Возвращаемое значение

Promise<void>

Наследуется от IPublicClientApplication.loginRedirect

logout(EndSessionRequest)

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

Параметры

logoutRequest

EndSessionRequest

Возвращаемое значение

Promise<void>

Наследуется от IPublicClientApplication.logout

logoutPopup(EndSessionPopupRequest)

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

Параметры

logoutRequest

EndSessionPopupRequest

Возвращаемое значение

Promise<void>

Наследуется от IPublicClientApplication.logoutPopup

logoutRedirect(EndSessionRequest)

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

Параметры

logoutRequest

EndSessionRequest

Возвращаемое значение

Promise<void>

Наследуется от IPublicClientApplication.logoutRedirect

removeEventCallback(string)

function removeEventCallback(callbackId: string)

Параметры

callbackId

string

Наследуется от IPublicClientApplication.removeEventCallback

removePerformanceCallback(string)

function removePerformanceCallback(callbackId: string): boolean

Параметры

callbackId

string

Возвращаемое значение

boolean

Наследуется от IPublicClientApplication.removePerformanceCallback

setActiveAccount(null | AccountInfo)

function setActiveAccount(account: null | AccountInfo)

Параметры

account

null | AccountInfo

Наследуется от IPublicClientApplication.setActiveAccount

setLogger(Logger)

function setLogger(logger: Logger)

Параметры

logger

Logger

Наследуется от IPublicClientApplication.setLogger

setNavigationClient(INavigationClient)

function setNavigationClient(navigationClient: INavigationClient)

Параметры

navigationClient

INavigationClient

Наследуется от 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>

Параметры

request

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

Возвращаемое значение

Promise<AuthenticationResult>

Наследуется от IPublicClientApplication.ssoSilent