PublicClientApplication class

new PublicClientApplication(configuration: Configuration, controller?: IController)

Parametry

Tato funkce uplatní autorizační kód (předaný jako kód) z koncového bodu tokenu eSTS. Tento autorizační kód by měl být získán na straně serveru pomocí důvěrného klienta k získání spa_code. Toto rozhraní API není zatěžováno pro běžné získání a uplatnění autorizačního kódu.

Uplatnění tohoto autorizačního kódu nebude vyžadovat PKCE, protože ho získal důvěrný klient.

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

Parametry

Návraty

Příslib, který se splní, když se tato funkce dokončí nebo odmítne, pokud byla vyvolána chyba.

Použijte, když chcete získat access_token pro rozhraní API prostřednictvím otevření automaticky otevírané okno v prohlížeči uživatele.

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

Parametry

Návraty

Příslib, který se splní, když se tato funkce dokončí nebo odmítne, pokud byla vyvolána chyba.

Použijte, když chcete získat access_token pro vaše rozhraní API přesměrováním okna prohlížeče uživatele do koncového bodu autorizace. Tato funkce přesměruje stránku, takže žádný kód, který následuje za touto funkcí, se nespustí.

DŮLEŽITÉ: Nedoporučuje se mít kód, který je závislý na řešení příslibu. Tato funkce přejde mimo aktuální okno prohlížeče. V současné době vrací příslib, aby odrážel asynchronní povahu kódu spuštěného v této funkci.

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

Parametry

Návraty

Bezobslužné získání přístupového tokenu pro danou sadu oborů Vrátí v současné době příslib zpracování, pokud jsou provedeny paralelní požadavky.

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

Parametry

Návraty

• příslib, který je splněn při dokončení této funkce nebo zamítnut, pokud byla vyvolána chyba. Vrátí objekt AuthenticationResult .

Přidá zpětná volání událostí do pole.

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

Parametry

Návraty

Zaregistruje zpětné volání pro příjem událostí výkonu.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametry

Návraty

Vymaže tokeny a účet z mezipaměti prohlížeče.

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

Parametry

Návraty

Vytvoří StandardController a předá ho do PublicClientApplication.

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

Parametry

Návraty

Odebere naslouchací proces událostí, který vygeneruje událost při přidání nebo odebrání uživatelského účtu z localstorage na jiné kartě nebo okně prohlížeče.

function disableAccountStorageEvents()

Přidá naslouchací proces událostí, který vygeneruje událost při přidání nebo odebrání uživatelského účtu z místního prostředí na jiné kartě nebo okně prohlížeče.

function enableAccountStorageEvents()

Vrátí první účet nalezený v mezipaměti, který odpovídá filtru účtu předaného.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parametry

Návraty

První účet nalezený v mezipaměti odpovídající zadanému filtru nebo hodnotě null, pokud nebyl nalezen žádný účet.

Vrátí přihlášený účet odpovídající homeAccountId. (objekt účtu se vytvoří v době úspěšného přihlášení) nebo null, pokud se nenajde žádný odpovídající účet.

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parametry

Návraty

Objekt účtu uložený v knihovně MSAL

Vrátí přihlášený účet odpovídající localAccountId. (objekt účtu se vytvoří v době úspěšného přihlášení) nebo null, pokud se nenajde žádný odpovídající účet.

function getAccountByLocalId(localId: string): null | AccountInfo

Parametry

Návraty

Objekt účtu uložený v knihovně MSAL

Vrátí přihlášený účet odpovídající uživatelskému jménu. (objekt účtu se vytvoří v době úspěšného přihlášení) nebo null, pokud se nenajde žádný odpovídající účet. Toto rozhraní API je k dispozici pro usnadnění, ale pro zajištění nejlepší spolehlivosti by se mělo použít getAccountById.

function getAccountByUsername(userName: string): null | AccountInfo

Parametry

Návraty

Objekt účtu uložený v knihovně MSAL

Získá aktuálně aktivní účet.

function getActiveAccount(): null | AccountInfo

Návraty

Vrátí všechny účty v mezipaměti, které odpovídají volitelnému filtru. Pokud není zadaný žádný filtr, vrátí se všechny účty.

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

Parametry

Návraty

Pole objektů AccountInfo v mezipaměti

Vrátí instanci protokolovacího nástroje.

function getLogger(): Logger

Návraty

Získá mezipaměť tokenů pro aplikaci.

function getTokenCache(): ITokenCache

Návraty

Funkce obslužné rutiny události, která uživatelům umožňuje aktivovat události po načtení objektu PublicClientApplication během toků přesměrování. To by se mělo vyvolat na všech stránkách, které se týkají toků ověřování přesměrování.

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

Parametry

Návraty

Odpověď tokenu nebo hodnota null. Pokud je vrácená hodnota null, nebylo zjištěno žádné přesměrování ověřování.

Hydratuje mezipaměť s tokeny a účtem v objektu AuthenticationResult

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

Parametry

Návraty

Inicializační funkce pro provádění asynchronních spouštěcích úloh, jako je připojení k rozšíření WAM

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

Parametry

Návraty

Volané obálkovými knihovnami (Angular &React) pro nastavení skladové položky a verze předávané telemetrii, protokolovacímu modulu atd.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parametry

Používá se při zahájení procesu přihlášení otevřením automaticky otevírané okno v prohlížeči uživatele.

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

Parametry

Návraty

Příslib, který se splní, když se tato funkce dokončí nebo odmítne, pokud byla vyvolána chyba.

Použije se při zahájení procesu přihlášení přesměrováním prohlížeče uživatele na koncový bod autorizace. Tato funkce přesměruje stránku, takže žádný kód, který následuje za touto funkcí, se nespustí.

DŮLEŽITÉ: Nedoporučuje se mít kód, který je závislý na řešení příslibu. Tato funkce přejde mimo aktuální okno prohlížeče. V současné době vrací příslib, aby odrážel asynchronní povahu kódu spuštěného v této funkci.

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

Parametry

Návraty

Zastaralá funkce odhlášení. Místo toho použijte logoutRedirect nebo logoutPopup.

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

Parametry

Návraty

Vymaže místní mezipaměť aktuálního uživatele a otevře automaticky otevírané okno s výzvou k odhlášení ze serveru.

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

Parametry

Návraty

Slouží k odhlášení aktuálního uživatele a přesměrování uživatele na postLogoutRedirectUri. Výchozí chování je přesměrování uživatele na window.location.hrefadresu .

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

Parametry

Návraty

Odebere zpětné volání se zadaným ID z pole zpětného volání.

function removeEventCallback(callbackId: string)

Parametry

Odebere zpětné volání registrované pomocí addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parametry

Návraty

Nastaví účet, který se má použít jako aktivní účet. Pokud se do rozhraní acquireToken API nepředá žádný účet, nástroj MSAL použije tento aktivní účet.

function setActiveAccount(account: null | AccountInfo)

Parametry

Nahradí výchozí protokolovací sadu v konfiguracích novým protokolovacím nástrojem novými konfiguracemi.

function setLogger(logger: Logger)

Parametry

Nastaví navigačního klienta.

function setNavigationClient(navigationClient: INavigationClient)

Parametry

Tato funkce používá skrytý prvek iframe k načtení autorizačního kódu z eSTS. Existují případy, kdy to nemusí fungovat:

• Libovolný prohlížeč používající formu inteligentní prevence sledování
• Pokud neexistuje vytvořená relace se službou

V těchto případech musí být požadavek proveden uvnitř automaticky otevírané nebo úplné přesměrování rámce.

V případech, kdy je vyžadována interakce, nelze odeslat požadavek s výzvou =none.

Pokud vypršela platnost obnovovacího tokenu, můžete pomocí této funkce načíst novou sadu tokenů bezobslužně, pokud relace na serveru stále existuje.

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

Parametry

Návraty

Příslib, který se splní, když se tato funkce dokončí nebo odmítne, pokud byla vyvolána chyba.