CustomAuthPublicClientApplication class

Skapar en ny instans av en PublicClientApplication med den angivna konfigurationen och kontrollanten för att starta interna autentiseringsflöden

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

Parametrar

Returer

• Ett löfte som matchar en CustomAuthPublicClientApplication-instans

Hämtar det aktuella kontot från webbläsarens cacheminne.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parametrar

Returer

• Resultatet av get-kontoåtgärden

Initierar återställning av lösenordsflödet. Den här metoden resulterar i att extra åtgärd utlöses (skicka kod) för att slutföra återställningslösenordet. Skapa resultat med felinformation om något undantag utlöses.

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

Parametrar

Returer

• Ett löfte som matchar ResetPasswordStartResult

Initierar inloggningsflödet. Den här metoden resulterar i slutförande av inloggning eller extra åtgärder (lösenord, kod osv.) som krävs för att slutföra inloggningen. Skapa resultat med felinformation om något undantag utlöses.

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

Parametrar

Returer

• Ett löfte som matchar SignInResult

Initierar registreringsflödet. Den här metoden resulterar i slutförande av registrering eller extra åtgärder (lösenord, kod osv.) som krävs för att slutföra registreringen. Skapa resultat med felinformation om något undantag utlöses.

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

Parametrar

Returer

• Ett löfte som matchar SignUpResult

Den här funktionen löser in en auktoriseringskod (skickas som kod) från eSTS-tokenslutpunkten. Den här auktoriseringskoden bör hämtas på serversidan med hjälp av en konfidentiell klient för att hämta en spa_code. Det här API:et läggs inte till för normalt anskaffning och inlösen av auktoriseringskod.

Inlösen av den här auktoriseringskoden kräver inte PKCE, eftersom den förvärvades av en konfidentiell klient.

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

Parametrar

Returer

Ett löfte som uppfylls när den här funktionen har slutförts eller avvisats om ett fel uppstod.

Ärvd från PublicClientApplication.acquireTokenByCode

Använd när du vill hämta en access_token för ditt API genom att öppna ett popup-fönster i användarens webbläsare

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

Parametrar

Returer

Ett löfte som uppfylls när den här funktionen har slutförts eller avvisats om ett fel uppstod.

Ärvd från PublicClientApplication.acquireTokenPopup

Använd när du vill hämta en access_token för ditt API genom att omdirigera användarens webbläsarfönster till auktoriseringsslutpunkten. Den här funktionen omdirigerar sidan, så all kod som följer den här funktionen körs inte.

VIKTIGT: Vi rekommenderar INTE att du har kod som är beroende av lösningen för Promise. Den här funktionen navigerar bort från det aktuella webbläsarfönstret. Det returnerar för närvarande ett löfte för att återspegla den asynkrona karaktären hos den kod som körs i den här funktionen.

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

Parametrar

Returer

Ärvd från PublicClientApplication.acquireTokenRedirect

Hämta tyst en åtkomsttoken för en viss uppsättning omfång. Returnerar för närvarande bearbetningslöfte om parallella begäranden görs.

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

Parametrar

Returer

• ett löfte som uppfylls när den här funktionen har slutförts eller avvisats om ett fel uppstod. Returnerar objektet AuthenticationResult

Ärvd från PublicClientApplication.acquireTokenSilent

Lägger till händelseåteranrop till matrisen

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

Parametrar

Returer

Ärvd från PublicClientApplication.addEventCallback

Registrerar ett återanrop för att ta emot prestandahändelser.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametrar

Returer

Ärvd från PublicClientApplication.addPerformanceCallback

Rensar token och konto från webbläsarens cacheminne.

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

Parametrar

Returer

Ärvd från PublicClientApplication.clearCache

Skapar StandardController och skickar den till PublicClientApplication

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

Parametrar

Returer

Ärvd från PublicClientApplication.createPublicClientApplication

Tar bort händelselyssnare som genererar en händelse när ett användarkonto läggs till eller tas bort från localstorage i en annan webbläsarflik eller ett annat fönster

function disableAccountStorageEvents()

Ärvd från PublicClientApplication.disableAccountStorageEvents

Lägger till händelselyssnare som genererar en händelse när ett användarkonto läggs till eller tas bort från localstorage i en annan webbläsarflik eller ett annat fönster

function enableAccountStorageEvents()

Ärvd från PublicClientApplication.enableAccountStorageEvents

Returnerar det första kontot som finns i cacheminnet som matchar kontofiltret som skickas in.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parametrar

Returer

Det första kontot hittades i cacheminnet som matchar det angivna filtret eller null om inget konto kunde hittas.

Ärvd från PublicClientApplication.getAccount

Returnerar det inloggade kontot som matchar homeAccountId. (kontoobjektet skapas vid tidpunkten för lyckad inloggning) eller null när inget matchande konto hittas

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parametrar

Returer

Kontoobjektet som lagras i MSAL

Ärvd från PublicClientApplication.getAccountByHomeId

Returnerar det inloggade kontot som matchar localAccountId. (kontoobjektet skapas vid tidpunkten för lyckad inloggning) eller null när inget matchande konto hittas

function getAccountByLocalId(localId: string): null | AccountInfo

Parametrar

Returer

Kontoobjektet som lagras i MSAL

Ärvd från PublicClientApplication.getAccountByLocalId

Returnerar det inloggningskonto som matchar användarnamnet. (kontoobjektet skapas vid tidpunkten för den lyckade inloggningen) eller null när inget matchande konto hittas. Det här API:et tillhandahålls för enkelhetens skull, men getAccountById bör användas för bästa tillförlitlighet

function getAccountByUsername(userName: string): null | AccountInfo

Parametrar

Returer

Kontoobjektet som lagras i MSAL

Ärvd från PublicClientApplication.getAccountByUsername

Hämtar det aktiva kontot

function getActiveAccount(): null | AccountInfo

Returer

Ärvd från PublicClientApplication.getActiveAccount

Returnerar alla konton i cacheminnet som matchar det valfria filtret. Om inget filter anges returneras alla konton.

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

Parametrar

Returer

Matris med AccountInfo-objekt i cacheminnet

Ärvd från PublicClientApplication.getAllAccounts

Returnerar logger-instansen

function getLogger(): Logger

Returer

Ärvd från PublicClientApplication.getLogger

Hämtar tokencachen för programmet.

function getTokenCache(): ITokenCache

Returer

Ärvd från PublicClientApplication.getTokenCache

Händelsehanterarfunktion som gör det möjligt för användare att utlösa händelser när PublicClientApplication-objektet har lästs in under omdirigeringsflöden. Detta bör anropas på alla sidinläsningar som ingår i omdirigeringsautentiseringsflöden.

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

Parametrar

Returer

Tokensvar eller null. Om returvärdet är null identifierades ingen autentiseringsomdirigering.

Ärvd från PublicClientApplication.handleRedirectPromise

Hydraterar cacheminnet med token och kontot i AuthenticationResult-objektet

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

Parametrar

Returer

Ärvd från PublicClientApplication.hydrateCache

Initieringsfunktion för att utföra asynkrona startuppgifter, till exempel anslutning till WAM-tillägg

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

Parametrar

Returer

Ärvd från PublicClientApplication.initialize

Anropas av omslutningsbibliotek (Angular & React) för att ange SKU och version som skickas till telemetri, logger osv.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parametrar

Ärvd från PublicClientApplication.initializeWrapperLibrary

Använd när du initierar inloggningsprocessen genom att öppna ett popup-fönster i användarens webbläsare

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

Parametrar

Returer

Ett löfte som uppfylls när den här funktionen har slutförts eller avvisats om ett fel uppstod.

Ärvd från PublicClientApplication.loginPopup

Använd när du initierar inloggningsprocessen genom att omdirigera användarens webbläsare till auktoriseringsslutpunkten. Den här funktionen omdirigerar sidan, så all kod som följer den här funktionen körs inte.

VIKTIGT: Vi rekommenderar INTE att du har kod som är beroende av lösningen för Promise. Den här funktionen navigerar bort från det aktuella webbläsarfönstret. Det returnerar för närvarande ett löfte för att återspegla den asynkrona karaktären hos den kod som körs i den här funktionen.

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

Parametrar

Returer

Ärvd från PublicClientApplication.loginRedirect

Inaktuell utloggningsfunktion. Använd logoutRedirect eller logoutPopup i stället

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

Parametrar

Returer

Ärvd från PublicClientApplication.logout

Rensar lokal cache för den aktuella användaren och öppnar sedan ett popup-fönster där användaren uppmanas att logga ut från servern

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

Parametrar

Returer

Ärvd från PublicClientApplication.logoutPopup

Använd för att logga ut den aktuella användaren och omdirigera användaren till postLogoutRedirectUri. Standardbeteendet är att omdirigera användaren till window.location.href.

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

Parametrar

Returer

Ärvd från PublicClientApplication.logoutRedirect

Tar bort motringning med angivet ID från motringningsmatrisen

function removeEventCallback(callbackId: string)

Parametrar

Ärvd från PublicClientApplication.removeEventCallback

Tar bort ett återanrop som registrerats med addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametrar

Returer

Ärvd från PublicClientApplication.removePerformanceCallback

Anger det konto som ska användas som aktivt konto. Om inget konto skickas till acquireToken-API:erna använder MSAL det här aktiva kontot.

function setActiveAccount(account: null | AccountInfo)

Parametrar

Ärvd från PublicClientApplication.setActiveAccount

Ersätter standardloggningsuppsättningen i konfigurationer med nya Logger med nya konfigurationer

function setLogger(logger: Logger)

Parametrar

Ärvd från PublicClientApplication.setLogger

Anger navigeringsklient

function setNavigationClient(navigationClient: INavigationClient)

Parametrar

Ärvd från PublicClientApplication.setNavigationClient

Den här funktionen använder en dold iframe för att hämta en auktoriseringskod från eSTS. Det finns fall där detta kanske inte fungerar:

• Alla webbläsare som använder en form av intelligent spårningsskydd
• Om det inte finns en etablerad session med tjänsten

I dessa fall måste begäran göras i en popup- eller fullständig ramomdirigering.

I de fall där interaktion krävs kan du inte skicka en begäran med prompt=none.

Om din uppdateringstoken har upphört att gälla kan du använda den här funktionen för att hämta en ny uppsättning token tyst så länge sessionen på servern fortfarande finns.

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

Parametrar

Returer

Ett löfte som uppfylls när den här funktionen har slutförts eller avvisats om ett fel uppstod.

Ärvd från PublicClientApplication.ssoSilent