CustomAuthPublicClientApplication class

Erstellt eine neue Instanz einer PublicClientApplication mit der angegebenen Konfiguration und dem angegebenen Controller, um systemeigene Authentifizierungsflüsse zu starten

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

Parameter

Gibt zurück

• Eine Zusage, die in eine CustomAuthPublicClientApplication-Instanz aufgelöst wird

Ruft das aktuelle Konto aus dem Browsercache ab.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parameter

Gibt zurück

• Das Ergebnis des Vorgangs "Konto abrufen"

Initiiert den Zurücksetzungskennwortfluss. Diese Methode führt dazu, dass zusätzliche Aktion (Sendecode) ausgelöst wird, um das Zurücksetzungskennwort abzuschließen. Erstellen Sie ein Ergebnis mit Fehlerdetails, wenn eine Ausnahme ausgelöst wurde.

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

Parameter

Gibt zurück

• Eine Zusage, die zu ResetPasswordStartResult aufgelöst wird

Initiiert den Anmeldefluss. Diese Methode führt zum Abschließen der Anmeldung oder zu zusätzlichen Aktionen (Kennwort, Code usw.), die zum Abschließen der Anmeldung erforderlich sind. Erstellen Sie ein Ergebnis mit Fehlerdetails, wenn eine Ausnahme ausgelöst wurde.

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

Parameter

Gibt zurück

• Eine Zusage, die in SignInResult aufgelöst wird

Initiiert den Registrierungsablauf. Diese Methode führt zum Abschließen der Registrierung oder zu zusätzlichen Aktionen (Kennwort, Code usw.), die zum Abschließen der Registrierung erforderlich sind. Erstellen Sie ein Ergebnis mit Fehlerdetails, wenn eine Ausnahme ausgelöst wurde.

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

Parameter

Gibt zurück

• Eine Zusage, die in SignUpResult aufgelöst wird

Diese Funktion löst einen Autorisierungscode (als Code übergeben) vom eSTS-Tokenendpunkt ein. Dieser Autorisierungscode sollte serverseitig mithilfe eines vertraulichen Clients abgerufen werden, um eine spa_code zu erwerben. Diese API wird nicht für die normale Autorisierungscodeakquise und -einlösung eingerückt.

Die Einlösung dieses Autorisierungscodes erfordert keine PKCE, da sie von einem vertraulichen Kunden erworben wurde.

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

Parameter

Gibt zurück

Eine Zusage, die erfüllt ist, wenn diese Funktion abgeschlossen wurde, oder abgelehnt, wenn ein Fehler ausgelöst wurde.

Geerbt von PublicClientApplication.acquireTokenByCode

Verwenden Sie diesen Vorgang, wenn Sie eine access_token für Ihre API abrufen möchten, indem Sie ein Popupfenster im Browser des Benutzers öffnen.

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

Parameter

Gibt zurück

Eine Zusage, die erfüllt ist, wenn diese Funktion abgeschlossen wurde, oder abgelehnt, wenn ein Fehler ausgelöst wurde.

Geerbt von PublicClientApplication.acquireTokenPopup

Verwenden Sie diesen Vorgang, wenn Sie eine access_token für Ihre API abrufen möchten, indem Sie das Browserfenster des Benutzers an den Autorisierungsendpunkt umleiten. Diese Funktion leitet die Seite um, sodass code, der auf diese Funktion folgt, nicht ausgeführt wird.

WICHTIG: Es wird NICHT empfohlen, Code zu haben, der von der Auflösung der Zusage abhängig ist. Diese Funktion navigiert vom aktuellen Browserfenster weg. Es gibt derzeit eine Zusage zurück, um die asynchrone Art des Codes widerzuspiegeln, der in dieser Funktion ausgeführt wird.

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.acquireTokenRedirect

Rufen Sie automatisch ein Zugriffstoken für einen bestimmten Satz von Bereichen ab. Gibt zurzeit eine Zusage zur Verarbeitung zurück, wenn parallele Anforderungen gestellt werden.

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

Parameter

Gibt zurück

• eine Zusage, die erfüllt wird, wenn diese Funktion abgeschlossen wurde, oder abgelehnt, wenn ein Fehler ausgelöst wurde. Gibt das AuthenticationResult Objekt zurück.

Geerbt von PublicClientApplication.acquireTokenSilent

Fügt Dem Array Ereignisrückrufe hinzu.

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.addEventCallback

Registriert einen Rückruf zum Empfangen von Leistungsereignissen.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameter

Gibt zurück

Geerbt von PublicClientApplication.addPerformanceCallback

Löscht Token und Konto aus dem Browsercache.

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.clearCache

Erstellt StandardController und übergibt ihn an die PublicClientApplication

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.createPublicClientApplication

Entfernt ereignislistener, der ein Ereignis ausgibt, wenn ein Benutzerkonto in einer anderen Browserregisterkarte oder einem anderen Browserfenster hinzugefügt oder daraus entfernt wird.

function disableAccountStorageEvents()

Geerbt von PublicClientApplication.disableAccountStorageEvents

Fügt Ereignislistener hinzu, der ein Ereignis ausgibt, wenn ein Benutzerkonto in einer anderen Browserregisterkarte oder einem anderen Browserfenster hinzugefügt oder aus dem LocalStorage entfernt wird.

function enableAccountStorageEvents()

Geerbt von PublicClientApplication.enableAccountStorageEvents

Gibt das erste Konto im Cache zurück, das dem übergebenen Kontofilter entspricht.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parameter

Gibt zurück

Das erste Konto, das im Cache gefunden wurde, das dem bereitgestellten Filter oder null entspricht, wenn kein Konto gefunden werden konnte.

Geerbt von PublicClientApplication.getAccount

Gibt die angemeldete kontoabgleiche homeAccountId zurück. (das Kontoobjekt wird zum Zeitpunkt der erfolgreichen Anmeldung erstellt) oder NULL, wenn kein übereinstimmender Konto gefunden wird.

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parameter

Gibt zurück

Das kontoobjekt, das in MSAL gespeichert ist

Geerbt von PublicClientApplication.getAccountByHomeId

Gibt die angemeldete kontoabgleiche localAccountId zurück. (das Kontoobjekt wird zum Zeitpunkt der erfolgreichen Anmeldung erstellt) oder NULL, wenn kein übereinstimmender Konto gefunden wird.

function getAccountByLocalId(localId: string): null | AccountInfo

Parameter

Gibt zurück

Das kontoobjekt, das in MSAL gespeichert ist

Geerbt von PublicClientApplication.getAccountByLocalId

Gibt den angemeldeten Kontonamen zurück, der dem Benutzernamen entspricht. (das Kontoobjekt wird zum Zeitpunkt der erfolgreichen Anmeldung erstellt) oder NULL, wenn kein übereinstimmende Konto gefunden wird. Diese API wird zur Vereinfachung bereitgestellt, aber getAccountById sollte für optimale Zuverlässigkeit verwendet werden.

function getAccountByUsername(userName: string): null | AccountInfo

Parameter

Gibt zurück

Das kontoobjekt, das in MSAL gespeichert ist

Geerbt von PublicClientApplication.getAccountByUsername

Ruft das derzeit aktive Konto ab.

function getActiveAccount(): null | AccountInfo

Gibt zurück

Geerbt von PublicClientApplication.getActiveAccount

Gibt alle Konten im Cache zurück, die dem optionalen Filter entsprechen. Wenn kein Filter bereitgestellt wird, werden alle Konten zurückgegeben.

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

Parameter

Gibt zurück

Array von AccountInfo-Objekten im Cache

Geerbt von PublicClientApplication.getAllAccounts

Gibt die Loggerinstanz zurück.

function getLogger(): Logger

Gibt zurück

Geerbt von PublicClientApplication.getLogger

Ruft den Tokencache für die Anwendung ab.

function getTokenCache(): ITokenCache

Gibt zurück

Geerbt von PublicClientApplication.getTokenCache

Ereignishandlerfunktion, mit der Benutzer Ereignisse auslösen können, nachdem das PublicClientApplication-Objekt während der Umleitungsflüsse geladen wurde. Dies sollte auf allen Seitenladevorgängen aufgerufen werden, die an Umleitungs-Authentifizierungsflüssen beteiligt sind.

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

Parameter

Gibt zurück

Tokenantwort oder NULL. Wenn der Rückgabewert null ist, wurde keine Authentifizierungsumleitung erkannt.

Geerbt von PublicClientApplication.handleRedirectPromise

Hydrates cache with the tokens and account in the AuthenticationResult object

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.hydrateCache

Initialisierungsfunktion zum Ausführen asynchroner Startaufgaben, z. B. herstellen einer Verbindung mit der WAM-Erweiterung

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.initialize

Wird von Wrapperbibliotheken (Angular & React) aufgerufen, um SKU und Version festzulegen, die an Telemetrie, Logger usw. übergeben wurde.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parameter

Geerbt von PublicClientApplication.initializeWrapperLibrary

Verwendung beim Initiieren des Anmeldevorgangs durch Öffnen eines Popupfensters im Browser des Benutzers

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

Parameter

Gibt zurück

Eine Zusage, die erfüllt ist, wenn diese Funktion abgeschlossen wurde, oder abgelehnt, wenn ein Fehler ausgelöst wurde.

Geerbt von PublicClientApplication.loginPopup

Wird beim Initiieren des Anmeldevorgangs verwendet, indem Sie den Browser des Benutzers an den Autorisierungsendpunkt umleiten. Diese Funktion leitet die Seite um, sodass code, der auf diese Funktion folgt, nicht ausgeführt wird.

WICHTIG: Es wird NICHT empfohlen, Code zu haben, der von der Auflösung der Zusage abhängig ist. Diese Funktion navigiert vom aktuellen Browserfenster weg. Es gibt derzeit eine Zusage zurück, um die asynchrone Art des Codes widerzuspiegeln, der in dieser Funktion ausgeführt wird.

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.loginRedirect

Veraltete Abmeldefunktion. Verwenden Sie stattdessen "logoutRedirect" oder "logoutPopup".

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.logout

Löscht den lokalen Cache für den aktuellen Benutzer und öffnet dann ein Popupfenster, in dem der Benutzer aufgefordert wird, sich vom Server abzumelden.

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.logoutPopup

Wird verwendet, um den aktuellen Benutzer abzumelden und den Benutzer an den postLogoutRedirectUri umzuleiten. Das Standardverhalten besteht darin, den Benutzer auf window.location.href.

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

Parameter

Gibt zurück

Geerbt von PublicClientApplication.logoutRedirect

Entfernt Rückruf mit bereitgestellter ID aus dem Rückrufarray.

function removeEventCallback(callbackId: string)

Parameter

Geerbt von PublicClientApplication.removeEventCallback

Entfernt einen mit addPerformanceCallback registrierten Rückruf.

function removePerformanceCallback(callbackId: string): boolean

Parameter

Gibt zurück

Geerbt von PublicClientApplication.removePerformanceCallback

Legt das Konto fest, das als aktives Konto verwendet werden soll. Wenn kein Konto an die AcquireToken-APIs übergeben wird, verwendet MSAL dieses aktive Konto.

function setActiveAccount(account: null | AccountInfo)

Parameter

Geerbt von PublicClientApplication.setActiveAccount

Ersetzt den Standardprotokollierer in Konfigurationen durch neuen Logger durch neue Konfigurationen.

function setLogger(logger: Logger)

Parameter

Geerbt von PublicClientApplication.setLogger

Legt den Navigationsclient fest

function setNavigationClient(navigationClient: INavigationClient)

Parameter

Geerbt von PublicClientApplication.setNavigationClient

Diese Funktion verwendet einen ausgeblendeten iFrame, um einen Autorisierungscode aus dem eSTS abzurufen. Es gibt Fälle, in denen dies möglicherweise nicht funktioniert:

• Jeder Browser, der eine Form der intelligenten Tracking-Verhinderung verwendet
• Wenn keine festgelegte Sitzung mit dem Dienst vorhanden ist

In diesen Fällen muss die Anforderung innerhalb einer Popup- oder Vollframeumleitung erfolgen.

Für fälle, in denen interaktion erforderlich ist, können Sie keine Anforderung mit prompt=none senden.

Wenn Ihr Aktualisierungstoken abgelaufen ist, können Sie diese Funktion verwenden, um einen neuen Satz von Token im Hintergrund abzurufen, solange Die Sitzung auf dem Server noch vorhanden ist.

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

Parameter

Gibt zurück

Eine Zusage, die erfüllt ist, wenn diese Funktion abgeschlossen wurde, oder abgelehnt, wenn ein Fehler ausgelöst wurde.

Geerbt von PublicClientApplication.ssoSilent