CustomAuthPublicClientApplication class

Hiermee maakt u een nieuw exemplaar van een PublicClientApplication met de opgegeven configuratie en controller om systeemeigen verificatiestromen te starten

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

Parameters

Retouren

• Een belofte die wordt omgezet in een CustomAuthPublicClientApplication-exemplaar

Hiermee haalt u het huidige account op uit de browsercache.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parameters

Retouren

• Het resultaat van de get-accountbewerking

Hiermee wordt de wachtwoordstroom opnieuw instellen gestart. Deze methode resulteert in het activeren van extra actie (code verzenden) om het wachtwoord opnieuw instellen te voltooien. Maak resultaat met foutdetails als er een uitzondering is opgetreden.

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

Parameters

Retouren

• Een belofte die wordt omgezet in ResetPasswordStartResult

Start de aanmeldingsstroom. Deze methode resulteert in voltooiing van aanmelding of extra acties (wachtwoord, code, enzovoort) die nodig zijn om de aanmelding te voltooien. Maak resultaat met foutdetails als er een uitzondering is opgetreden.

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

Parameters

Retouren

• Een belofte die wordt omgezet in SignInResult

Hiermee wordt de registratiestroom gestart. Deze methode resulteert in het voltooien van de registratie of extra acties (wachtwoord, code, enzovoort) die nodig zijn om de registratie te voltooien. Maak resultaat met foutdetails als er een uitzondering is opgetreden.

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

Parameters

Retouren

• Een belofte die wordt omgezet in SignUpResult

Met deze functie wordt een autorisatiecode (doorgegeven als code) van het eSTS-tokeneindpunt ingewisseld. Deze autorisatiecode moet worden verkregen aan de serverzijde met behulp van een vertrouwelijke client om een spa_code te verkrijgen. Deze API is niet geïndend voor het verkrijgen en inwisselen van normale autorisatiecode.

Voor het inwisselen van deze autorisatiecode is geen PKCE vereist, omdat deze is verkregen door een vertrouwelijke client.

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

Parameters

Retouren

Een belofte die wordt uitgevoerd wanneer deze functie is voltooid of geweigerd als er een fout is opgetreden.

Overgenomen van PublicClientApplication.acquireTokenByCode

Gebruik deze opdracht wanneer u een access_token voor uw API wilt verkrijgen via het openen van een pop-upvenster in de browser van de gebruiker

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

Parameters

Retouren

Een belofte die wordt uitgevoerd wanneer deze functie is voltooid of geweigerd als er een fout is opgetreden.

Overgenomen van PublicClientApplication.acquireTokenPopup

Gebruik deze opdracht wanneer u een access_token voor uw API wilt verkrijgen door het browservenster van de gebruiker om te leiden naar het autorisatie-eindpunt. Met deze functie wordt de pagina omgeleid, zodat code die volgt op deze functie niet wordt uitgevoerd.

BELANGRIJK: Het wordt NIET aanbevolen om code te hebben die afhankelijk is van de resolutie van de Promise. Met deze functie navigeert u weg van het huidige browservenster. Er wordt momenteel een Promise geretourneerd om de asynchrone aard van de code die in deze functie wordt uitgevoerd, weer te geven.

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

Parameters

Retouren

Overgenomen van PublicClientApplication.acquireTokenRedirect

Verwerf op de achtergrond een toegangstoken voor een bepaalde set bereiken. Retourneert momenteel verwerkingsbelofte als parallelle aanvragen worden gedaan.

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

Parameters

Retouren

• een belofte die wordt uitgevoerd wanneer deze functie is voltooid of geweigerd als er een fout is opgetreden. Retourneert het AuthenticationResult object

Overgenomen van PublicClientApplication.acquireTokenSilent

Callbacks voor gebeurtenissen toevoegen aan matrix

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

Parameters

Retouren

Overgenomen van PublicClientApplication.addEventCallback

Registreert een callback om prestatie-gebeurtenissen te ontvangen.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

Retouren

Overgenomen van PublicClientApplication.addPerformanceCallback

Hiermee wist u tokens en accounts uit de browsercache.

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

Parameters

Retouren

Overgenomen van PublicClientApplication.clearCache

Hiermee maakt u StandardController en geeft u deze door aan publicClientApplication

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

Parameters

Retouren

Overgenomen van PublicClientApplication.createPublicClientApplication

Hiermee verwijdert u de gebeurtenislistener die een gebeurtenis verzendt wanneer een gebruikersaccount wordt toegevoegd aan of verwijderd uit localstorage in een ander browsertabblad of -venster

function disableAccountStorageEvents()

Overgenomen van PublicClientApplication.disableAccountStorageEvents

Voegt gebeurtenislistener toe die een gebeurtenis verzendt wanneer een gebruikersaccount wordt toegevoegd aan of verwijderd uit localstorage in een ander browsertabblad of -venster

function enableAccountStorageEvents()

Overgenomen van PublicClientApplication.enableAccountStorageEvents

Retourneert het eerste account dat is gevonden in de cache die overeenkomt met het accountfilter dat is doorgegeven.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parameters

Retouren

Het eerste account dat is gevonden in de cache die overeenkomt met het opgegeven filter of null als er geen account is gevonden.

Overgenomen van PublicClientApplication.getAccount

Retourneert het aangemelde account dat overeenkomt met homeAccountId. (het accountobject wordt gemaakt op het moment van geslaagde aanmelding) of null wanneer er geen overeenkomend account wordt gevonden

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parameters

Retouren

Het accountobject dat is opgeslagen in MSAL

Overgenomen van PublicClientApplication.getAccountByHomeId

Retourneert het aangemelde account dat overeenkomt met localAccountId. (het accountobject wordt gemaakt op het moment van geslaagde aanmelding) of null wanneer er geen overeenkomend account wordt gevonden

function getAccountByLocalId(localId: string): null | AccountInfo

Parameters

Retouren

Het accountobject dat is opgeslagen in MSAL

Overgenomen van PublicClientApplication.getAccountByLocalId

Retourneert de aangemelde account die overeenkomt met de gebruikersnaam. (het accountobject wordt gemaakt op het moment van geslaagde aanmelding) of null wanneer er geen overeenkomend account wordt gevonden. Deze API is voor het gemak beschikbaar, maar getAccountById moet worden gebruikt voor de beste betrouwbaarheid

function getAccountByUsername(userName: string): null | AccountInfo

Parameters

Retouren

Het accountobject dat is opgeslagen in MSAL

Overgenomen van PublicClientApplication.getAccountByUsername

Hiermee wordt het momenteel actieve account ophaalt

function getActiveAccount(): null | AccountInfo

Retouren

Overgenomen van PublicClientApplication.getActiveAccount

Retourneert alle accounts in de cache die overeenkomen met het optionele filter. Als er geen filter is opgegeven, worden alle accounts geretourneerd.

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

Parameters

Retouren

Matrix van AccountInfo-objecten in cache

Overgenomen van PublicClientApplication.getAllAccounts

Retourneert het loggerexemplaren

function getLogger(): Logger

Retouren

Overgenomen van PublicClientApplication.getLogger

Hiermee haalt u de tokencache voor de toepassing op.

function getTokenCache(): ITokenCache

Retouren

Overgenomen van PublicClientApplication.getTokenCache

Gebeurtenis-handlerfunctie waarmee gebruikers gebeurtenissen kunnen activeren nadat het PublicClientApplication-object is geladen tijdens omleidingsstromen. Dit moet worden aangeroepen op alle paginabelastingen die betrokken zijn bij omleidingsverificatiestromen.

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

Parameters

Retouren

Tokenantwoord of null. Als de retourwaarde null is, is er geen verificatieomleiding gedetecteerd.

Overgenomen van PublicClientApplication.handleRedirectPromise

Hydrateert cache met de tokens en het account in het AuthenticationResult-object

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

Parameters

Retouren

Overgenomen van PublicClientApplication.hydrateCache

Initializer-functie voor het uitvoeren van asynchrone opstarttaken, zoals het maken van verbinding met de WAM-extensie

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

Parameters

Retouren

Overgenomen van PublicClientApplication.initialize

Aangeroepen door wrapper-bibliotheken (Angular & React) om SKU en versie in te stellen die zijn doorgegeven aan telemetrie, logger, enzovoort.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parameters

Overgenomen van PublicClientApplication.initializeWrapperLibrary

Gebruiken bij het initiëren van het aanmeldingsproces via het openen van een pop-upvenster in de browser van de gebruiker

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

Parameters

Retouren

Een belofte die wordt uitgevoerd wanneer deze functie is voltooid of geweigerd als er een fout is opgetreden.

Overgenomen van PublicClientApplication.loginPopup

Gebruik deze methode bij het initiëren van het aanmeldingsproces door de browser van de gebruiker om te leiden naar het autorisatie-eindpunt. Met deze functie wordt de pagina omgeleid, zodat code die volgt op deze functie niet wordt uitgevoerd.

BELANGRIJK: Het wordt NIET aanbevolen om code te hebben die afhankelijk is van de resolutie van de Promise. Met deze functie navigeert u weg van het huidige browservenster. Er wordt momenteel een Promise geretourneerd om de asynchrone aard van de code die in deze functie wordt uitgevoerd, weer te geven.

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

Parameters

Retouren

Overgenomen van PublicClientApplication.loginRedirect

Afgeschafte afmeldingsfunctie. Gebruik in plaats daarvan logoutRedirect of logoutPopup

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

Parameters

Retouren

Overgenomen van PublicClientApplication.logout

Hiermee wist u de lokale cache voor de huidige gebruiker en wordt er een pop-upvenster geopend waarin de gebruiker wordt gevraagd zich af te melden bij de server

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

Parameters

Retouren

Overgenomen van PublicClientApplication.logoutPopup

Gebruik dit om de huidige gebruiker af te melden en de gebruiker om te leiden naar de postLogoutRedirectUri. Standaardgedrag is het omleiden van de gebruiker naar window.location.href.

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

Parameters

Retouren

Overgenomen van PublicClientApplication.logoutRedirect

Hiermee verwijdert u callback met opgegeven id uit callbackmatrix

function removeEventCallback(callbackId: string)

Parameters

Overgenomen van PublicClientApplication.removeEventCallback

Hiermee verwijdert u een callback geregistreerd bij addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parameters

Retouren

Overgenomen van PublicClientApplication.removePerformanceCallback

Hiermee stelt u het account in dat moet worden gebruikt als het actieve account. Als er geen account wordt doorgegeven aan de acquireToken-API's, gebruikt MSAL dit actieve account.

function setActiveAccount(account: null | AccountInfo)

Parameters

Overgenomen van PublicClientApplication.setActiveAccount

Vervangt de standaardlogger die is ingesteld in configuraties door nieuwe logger door nieuwe configuraties

function setLogger(logger: Logger)

Parameters

Overgenomen van PublicClientApplication.setLogger

Hiermee stelt u de navigatieclient in

function setNavigationClient(navigationClient: INavigationClient)

Parameters

Overgenomen van PublicClientApplication.setNavigationClient

Deze functie maakt gebruik van een verborgen iframe om een autorisatiecode op te halen uit de eSTS. Er zijn gevallen waarin dit mogelijk niet werkt:

• Elke browser die een vorm van Intelligente traceringspreventie gebruikt
• Als er geen tot stand gebrachte sessie met de service is

In deze gevallen moet de aanvraag worden gedaan binnen een pop-up of een volledige frameomleiding.

Voor de gevallen waarin interactie is vereist, kunt u geen aanvraag met prompt=geen verzenden.

Als uw vernieuwingstoken is verlopen, kunt u deze functie gebruiken om een nieuwe set tokens op de achtergrond op te halen zolang de sessie op de server nog steeds bestaat.

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

Parameters

Retouren

Een belofte die wordt uitgevoerd wanneer deze functie is voltooid of geweigerd als er een fout is opgetreden.

Overgenomen van PublicClientApplication.ssoSilent