PublicClientApplication class

Csomag:

@azure/msal-browser

A PublicClientApplication osztály az a tár által közzétett objektum, amely hitelesítési és engedélyezési funkciókat hajt végre egyoldalas alkalmazásokban az OAuth 2.0 engedélyezési kódfolyamatban leírt JWT-jogkivonatok PKCE-specifikációval történő beszerzéséhez.

Konstruktorok

PublicClientApplication(Configuration, IController)

Metódusok

acquireTokenByCode(AuthorizationCodeRequest)	Ez a függvény bevált egy (kódként átadott) engedélyezési kódot az eSTS-jogkivonat végpontjáról. Ezt az engedélyezési kódot kiszolgálóoldalon kell beszerezni egy bizalmas ügyféllel egy spa_code beszerzéséhez. Ez az API nincs engedélyezve a normál engedélyezési kód beszerzéséhez és beváltásához. Ennek az engedélyezési kódnak a beváltásához nincs szükség PKCE-re, mivel azt egy bizalmas ügyfél szerezte be.
acquireTokenPopup(PopupRequest)	Akkor használható, ha access_token szeretne beszerezni az API-hoz egy előugró ablak megnyitásával a felhasználó böngészőjében
acquireTokenRedirect(RedirectRequest)	Akkor használja, ha access_token szeretne beszerezni az API-hoz a felhasználó böngészőablakának az engedélyezési végpontra való átirányításával. Ez a függvény átirányítja a lapot, így a függvényt követő kódok nem lesznek végrehajtva. FONTOS: NEM ajánlott olyan kód használata, amely az ígéret feloldásától függ. Ez a függvény eltávolodik az aktuális böngészőablaktól. Jelenleg ígéretet ad vissza, hogy tükrözze az ebben a függvényben futó kód aszinkron jellegét.
acquireTokenSilent(SilentRequest)	Egy adott hatókörcsoport hozzáférési jogkivonatának csendes beszerzése. Az aktuális feldolgozási ígéretet adja vissza párhuzamos kérések esetén.
addEventCallback(EventCallbackFunction, EventType[])	Eseményvisszahívások hozzáadása tömbhöz
addPerformanceCallback(PerformanceCallbackFunction)	Visszahívást regisztrál a teljesítményesemények fogadásához.
clearCache(ClearCacheRequest)	Törli a jogkivonatokat és a fiókot a böngésző gyorsítótárából.
createPublicClientApplication(Configuration)	Létrehozza a StandardControllert, és átadja a PublicClientApplication-nek
disableAccountStorageEvents()	Eltávolítja az eseményt kibocsátó eseményt egy felhasználói fiók hozzáadásakor vagy eltávolításakor a localstorage-ból egy másik böngészőlapon vagy ablakban
enableAccountStorageEvents()	Olyan eseményfigyelőt ad hozzá, amely eseményt bocsát ki, amikor egy felhasználói fiókot hozzáad vagy eltávolít egy másik böngészőlapon vagy ablakban a localstorage-ból
getAccount(AccountFilter)	A gyorsítótárban talált első fiókot adja vissza, amely megfelel a megadott fiókszűrőnek.
getAccountByHomeId(string)	A homeAccountId azonosítónak megfelelő bejelentkezett fiókot adja vissza. (a fiókobjektum a sikeres bejelentkezéskor jön létre) vagy null értékű, ha nem található egyező fiók
getAccountByLocalId(string)	A localAccountId azonosítónak megfelelő bejelentkezett fiókot adja vissza. (a fiókobjektum a sikeres bejelentkezéskor jön létre) vagy null értékű, ha nem található egyező fiók
getAccountByUsername(string)	A bejelentkezett fióknak megfelelő felhasználónevet adja vissza. (a fiókobjektum a sikeres bejelentkezéskor jön létre), vagy null értékű, ha nem található egyező fiók. Ez az API a kényelem érdekében van megadva, de a getAccountById-et a legjobb megbízhatóság érdekében kell használni
getActiveAccount()	Lekéri az aktuálisan aktív fiókot
getAllAccounts(AccountFilter)	A gyorsítótárban lévő összes olyan fiókot adja vissza, amely megfelel az opcionális szűrőnek. Ha nincs megadva szűrő, a rendszer minden fiókot visszaad.
getLogger()	A naplózópéldányt adja vissza
getTokenCache()	Lekéri az alkalmazás jogkivonat-gyorsítótárát.
handleRedirectPromise(string)	Eseménykezelő függvény, amely lehetővé teszi, hogy a felhasználók eseményeket aktiváljanak, miután a PublicClientApplication objektum betöltődött az átirányítási folyamatok során. Ezt az átirányítási hitelesítési folyamatokban érintett összes oldalbetöltésnél meg kell hívni.
hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)	Hidratálja a gyorsítótárat a tokenekkel és a fiókkal az AuthenticationResult objektumban
initialize(InitializeApplicationRequest)	Inicializáló függvény az aszinkron indítási feladatok végrehajtásához, például a WAM-bővítményhez való csatlakozáshoz
initializeWrapperLibrary(WrapperSKU, string)	Burkolókódtárak (Angular > React) hívták meg, hogy a termékváltozat és a verzió átadva legyen a telemetriának, a naplózónak stb.
loginPopup(PopupRequest)	A bejelentkezési folyamat kezdeményezéséhez használja egy előugró ablak megnyitásával a felhasználó böngészőjében
loginRedirect(RedirectRequest)	A bejelentkezési folyamat kezdeményezéséhez használja a felhasználó böngészőjének az engedélyezési végpontra való átirányításával. Ez a függvény átirányítja a lapot, így a függvényt követő kódok nem lesznek végrehajtva. FONTOS: NEM ajánlott olyan kód használata, amely az ígéret feloldásától függ. Ez a függvény eltávolodik az aktuális böngészőablaktól. Jelenleg ígéretet ad vissza, hogy tükrözze az ebben a függvényben futó kód aszinkron jellegét.
logout(EndSessionRequest)	Elavult kijelentkezés függvény. Használja inkább a logoutRedirect vagy a logoutPopup függvényt
logoutPopup(EndSessionPopupRequest)	Törli az aktuális felhasználó helyi gyorsítótárát, majd megnyílik egy előugró ablak, amely arra kéri a felhasználót, hogy jelentkezzen ki a kiszolgálóról
logoutRedirect(EndSessionRequest)	Ezzel kijelentkezteti az aktuális felhasználót, és átirányítja a felhasználót a postLogoutRedirectUri fájlba. Az alapértelmezett viselkedés a felhasználó átirányítása a következőre window.location.href: .
removeEventCallback(string)	Eltávolítja a visszahívási tömbből a megadott azonosítóval rendelkező visszahívást
removePerformanceCallback(string)	Eltávolítja az addPerformanceCallback szolgáltatásban regisztrált visszahívást.
setActiveAccount(null | AccountInfo)	Beállítja, hogy a fiók aktív fiókként legyen használva. Ha nem ad át fiókot a acquireToken API-knak, akkor az MSAL ezt az aktív fiókot fogja használni.
setLogger(Logger)	A konfigurációkban beállított alapértelmezett naplózó lecserélése új naplózóra új konfigurációkra
setNavigationClient(INavigationClient)	Navigációs ügyfél beállítása
ssoSilent(Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)	Ez a függvény egy rejtett iframe-et használ egy engedélyezési kód lekéréséhez az eSTS-ből. Előfordulhat, hogy ez nem működik: Bármely böngésző, amely az Intelligens nyomon követés megelőzésének egy formáját használja Ha nincs létrehozott munkamenet a szolgáltatással Ezekben az esetekben a kérést előugró vagy teljes keretes átirányításon belül kell végrehajtani. Azokban az esetekben, amikor interakcióra van szükség, nem küldhet kérést a prompt=none paraméterrel. Ha a frissítési jogkivonat lejárt, ezzel a függvénnyel csendesen lekérhet egy új jogkivonatkészletet, amíg a kiszolgálón való munkamenet továbbra is létezik.

Konstruktor adatai

PublicClientApplication(Configuration, IController)

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

Paraméterek

configuration

Configuration

Az MSAL PublicClientApplication-példány objektuma

controller

IController

Metódus adatai

acquireTokenByCode(AuthorizationCodeRequest)

Ez a függvény bevált egy (kódként átadott) engedélyezési kódot az eSTS-jogkivonat végpontjáról. Ezt az engedélyezési kódot kiszolgálóoldalon kell beszerezni egy bizalmas ügyféllel egy spa_code beszerzéséhez. Ez az API nincs engedélyezve a normál engedélyezési kód beszerzéséhez és beváltásához.

Ennek az engedélyezési kódnak a beváltásához nincs szükség PKCE-re, mivel azt egy bizalmas ügyfél szerezte be.

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

Paraméterek

request

AuthorizationCodeRequest

AuthorizationCodeRequest

Válaszok

Promise<AuthenticationResult>

Ígéret, amely akkor teljesül, amikor a függvény befejeződött, vagy ha hiba lépett fel, elutasítva.

acquireTokenPopup(PopupRequest)

Akkor használható, ha access_token szeretne beszerezni az API-hoz egy előugró ablak megnyitásával a felhasználó böngészőjében

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

Paraméterek

request

PopupRequest

Válaszok

Promise<AuthenticationResult>

Ígéret, amely akkor teljesül, amikor a függvény befejeződött, vagy ha hiba lépett fel, elutasítva.

acquireTokenRedirect(RedirectRequest)

Akkor használja, ha access_token szeretne beszerezni az API-hoz a felhasználó böngészőablakának az engedélyezési végpontra való átirányításával. Ez a függvény átirányítja a lapot, így a függvényt követő kódok nem lesznek végrehajtva.

FONTOS: NEM ajánlott olyan kód használata, amely az ígéret feloldásától függ. Ez a függvény eltávolodik az aktuális böngészőablaktól. Jelenleg ígéretet ad vissza, hogy tükrözze az ebben a függvényben futó kód aszinkron jellegét.

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

Paraméterek

request

RedirectRequest

Válaszok

Promise<void>

acquireTokenSilent(SilentRequest)

Egy adott hatókörcsoport hozzáférési jogkivonatának csendes beszerzése. Az aktuális feldolgozási ígéretet adja vissza párhuzamos kérések esetén.

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

Paraméterek

silentRequest

SilentRequest

Válaszok

Promise<AuthenticationResult>

• egy ígéret, amely akkor teljesül, amikor a függvény befejeződött, vagy ha hiba merült fel, elutasítva. A AuthenticationResult objektumot adja vissza

addEventCallback(EventCallbackFunction, EventType[])

Eseményvisszahívások hozzáadása tömbhöz

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

Paraméterek

callback

EventCallbackFunction

eventTypes

EventType[]

Válaszok

null | string

addPerformanceCallback(PerformanceCallbackFunction)

Visszahívást regisztrál a teljesítményesemények fogadásához.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Paraméterek

callback

PerformanceCallbackFunction

Válaszok

string

clearCache(ClearCacheRequest)

Törli a jogkivonatokat és a fiókot a böngésző gyorsítótárából.

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

Paraméterek

logoutRequest

ClearCacheRequest

Válaszok

Promise<void>

createPublicClientApplication(Configuration)

Létrehozza a StandardControllert, és átadja a PublicClientApplication-nek

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

Paraméterek

configuration

Configuration

{Configuration}

Válaszok

Promise<IPublicClientApplication>

disableAccountStorageEvents()

Eltávolítja az eseményt kibocsátó eseményt egy felhasználói fiók hozzáadásakor vagy eltávolításakor a localstorage-ból egy másik böngészőlapon vagy ablakban

function disableAccountStorageEvents()

enableAccountStorageEvents()

Olyan eseményfigyelőt ad hozzá, amely eseményt bocsát ki, amikor egy felhasználói fiókot hozzáad vagy eltávolít egy másik böngészőlapon vagy ablakban a localstorage-ból

function enableAccountStorageEvents()

getAccount(AccountFilter)

A gyorsítótárban talált első fiókot adja vissza, amely megfelel a megadott fiókszűrőnek.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Paraméterek

accountFilter

AccountFilter

Válaszok

null | AccountInfo

A gyorsítótárban található első fiók megfelel a megadott szűrőnek, vagy null értékű, ha nem található fiók.

getAccountByHomeId(string)

Figyelmeztetés

Ez az API már elavult.

• Use getAccount instead

A homeAccountId azonosítónak megfelelő bejelentkezett fiókot adja vissza. (a fiókobjektum a sikeres bejelentkezéskor jön létre) vagy null értékű, ha nem található egyező fiók

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Paraméterek

homeAccountId

string

Válaszok

null | AccountInfo

Az MSAL-ben tárolt fiókobjektum

getAccountByLocalId(string)

Figyelmeztetés

Ez az API már elavult.

• Use getAccount instead

A localAccountId azonosítónak megfelelő bejelentkezett fiókot adja vissza. (a fiókobjektum a sikeres bejelentkezéskor jön létre) vagy null értékű, ha nem található egyező fiók

function getAccountByLocalId(localId: string): null | AccountInfo

Paraméterek

localId

string

Válaszok

null | AccountInfo

Az MSAL-ben tárolt fiókobjektum

getAccountByUsername(string)

Figyelmeztetés

Ez az API már elavult.

• Use getAccount instead

A bejelentkezett fióknak megfelelő felhasználónevet adja vissza. (a fiókobjektum a sikeres bejelentkezéskor jön létre), vagy null értékű, ha nem található egyező fiók. Ez az API a kényelem érdekében van megadva, de a getAccountById-et a legjobb megbízhatóság érdekében kell használni

function getAccountByUsername(userName: string): null | AccountInfo

Paraméterek

userName

string

Válaszok

null | AccountInfo

Az MSAL-ben tárolt fiókobjektum

getActiveAccount()

Lekéri az aktuálisan aktív fiókot

function getActiveAccount(): null | AccountInfo

Válaszok

null | AccountInfo

getAllAccounts(AccountFilter)

A gyorsítótárban lévő összes olyan fiókot adja vissza, amely megfelel az opcionális szűrőnek. Ha nincs megadva szűrő, a rendszer minden fiókot visszaad.

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

Paraméterek

accountFilter

AccountFilter

(Nem kötelező) szűrő a visszaadott fiókok szűkítéséhez

Válaszok

AccountInfo[]

AccountInfo-objektumok tömbje a gyorsítótárban

getLogger()

A naplózópéldányt adja vissza

function getLogger(): Logger

Válaszok

Logger

getTokenCache()

Lekéri az alkalmazás jogkivonat-gyorsítótárát.

function getTokenCache(): ITokenCache

Válaszok

ITokenCache

handleRedirectPromise(string)

Eseménykezelő függvény, amely lehetővé teszi, hogy a felhasználók eseményeket aktiváljanak, miután a PublicClientApplication objektum betöltődött az átirányítási folyamatok során. Ezt az átirányítási hitelesítési folyamatokban érintett összes oldalbetöltésnél meg kell hívni.

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

Paraméterek

hash

string

Kivonatot kell feldolgozni. A window.location.hash aktuális értékének alapértelmezett értéke. Csak akkor kell explicit módon megadni, ha a kezelendő válasz nem szerepel az aktuális értékben.

Válaszok

Promise<null | AuthenticationResult>

Jogkivonat-válasz vagy null. Ha a visszatérési érték null, akkor a rendszer nem észlelt hitelesítési átirányítást.

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

Hidratálja a gyorsítótárat a tokenekkel és a fiókkal az AuthenticationResult objektumban

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

Paraméterek

result

AuthenticationResult

request

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

Az AuthenticationResult beszerzéséhez használt kérelemobjektum

Válaszok

Promise<void>

initialize(InitializeApplicationRequest)

Inicializáló függvény az aszinkron indítási feladatok végrehajtásához, például a WAM-bővítményhez való csatlakozáshoz

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

Paraméterek

request

InitializeApplicationRequest

{? InitializeApplicationRequest}

Válaszok

Promise<void>

initializeWrapperLibrary(WrapperSKU, string)

Burkolókódtárak (Angular > React) hívták meg, hogy a termékváltozat és a verzió átadva legyen a telemetriának, a naplózónak stb.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Paraméterek

sku

WrapperSKU

version

string

loginPopup(PopupRequest)

A bejelentkezési folyamat kezdeményezéséhez használja egy előugró ablak megnyitásával a felhasználó böngészőjében

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

Paraméterek

request

PopupRequest

Válaszok

Promise<AuthenticationResult>

Ígéret, amely akkor teljesül, amikor a függvény befejeződött, vagy ha hiba lépett fel, elutasítva.

loginRedirect(RedirectRequest)

A bejelentkezési folyamat kezdeményezéséhez használja a felhasználó böngészőjének az engedélyezési végpontra való átirányításával. Ez a függvény átirányítja a lapot, így a függvényt követő kódok nem lesznek végrehajtva.

FONTOS: NEM ajánlott olyan kód használata, amely az ígéret feloldásától függ. Ez a függvény eltávolodik az aktuális böngészőablaktól. Jelenleg ígéretet ad vissza, hogy tükrözze az ebben a függvényben futó kód aszinkron jellegét.

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

Paraméterek

request

RedirectRequest

Válaszok

Promise<void>

logout(EndSessionRequest)

Figyelmeztetés

Ez az API már elavult.

Elavult kijelentkezés függvény. Használja inkább a logoutRedirect vagy a logoutPopup függvényt

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

Paraméterek

logoutRequest

EndSessionRequest

Válaszok

Promise<void>

logoutPopup(EndSessionPopupRequest)

Törli az aktuális felhasználó helyi gyorsítótárát, majd megnyílik egy előugró ablak, amely arra kéri a felhasználót, hogy jelentkezzen ki a kiszolgálóról

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

Paraméterek

logoutRequest

EndSessionPopupRequest

Válaszok

Promise<void>

logoutRedirect(EndSessionRequest)

Ezzel kijelentkezteti az aktuális felhasználót, és átirányítja a felhasználót a postLogoutRedirectUri fájlba. Az alapértelmezett viselkedés a felhasználó átirányítása a következőre window.location.href: .

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

Paraméterek

logoutRequest

EndSessionRequest

Válaszok

Promise<void>

removeEventCallback(string)

Eltávolítja a visszahívási tömbből a megadott azonosítóval rendelkező visszahívást

function removeEventCallback(callbackId: string)

Paraméterek

callbackId

string

removePerformanceCallback(string)

Eltávolítja az addPerformanceCallback szolgáltatásban regisztrált visszahívást.

function removePerformanceCallback(callbackId: string): boolean

Paraméterek

callbackId

string

Válaszok

boolean

setActiveAccount(null | AccountInfo)

Beállítja, hogy a fiók aktív fiókként legyen használva. Ha nem ad át fiókot a acquireToken API-knak, akkor az MSAL ezt az aktív fiókot fogja használni.

function setActiveAccount(account: null | AccountInfo)

Paraméterek

account

null | AccountInfo

setLogger(Logger)

A konfigurációkban beállított alapértelmezett naplózó lecserélése új naplózóra új konfigurációkra

function setLogger(logger: Logger)

Paraméterek

logger

Logger

Naplózópéldány

setNavigationClient(INavigationClient)

Navigációs ügyfél beállítása

function setNavigationClient(navigationClient: INavigationClient)

Paraméterek

navigationClient

INavigationClient

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

Ez a függvény egy rejtett iframe-et használ egy engedélyezési kód lekéréséhez az eSTS-ből. Előfordulhat, hogy ez nem működik:

• Bármely böngésző, amely az Intelligens nyomon követés megelőzésének egy formáját használja
• Ha nincs létrehozott munkamenet a szolgáltatással

Ezekben az esetekben a kérést előugró vagy teljes keretes átirányításon belül kell végrehajtani.

Azokban az esetekben, amikor interakcióra van szükség, nem küldhet kérést a prompt=none paraméterrel.

Ha a frissítési jogkivonat lejárt, ezzel a függvénnyel csendesen lekérhet egy új jogkivonatkészletet, amíg a kiszolgálón való munkamenet továbbra is létezik.

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

Paraméterek

request

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

SsoSilentRequest

Válaszok

Promise<AuthenticationResult>

Ígéret, amely akkor teljesül, amikor a függvény befejeződött, vagy ha hiba lépett fel, elutasítva.