@azure/msal-common package

Osztályok

AuthError	A MSAL.js könyvtár által létrehozott általános hibaosztály.
AuthenticationHeaderParser	Ez egy segédosztály, amely elemzi a támogatott HTTP-válaszhitelesítési fejléceket az alapszintű engedélyezési folyamatokon kívül használható fejléc-kihívások értékeinek kinyeréséhez és visszaadásához.
CacheError	Hiba történt a gyorsítótárral kapcsolatos hiba esetén
ClientAuthError	Hiba jelenik meg, ha hiba van a böngészőben futó ügyfélkódban.
ClientConfigurationError	Hiba történt a MSAL.js kódtár konfigurációjában.
InteractionRequiredAuthError	Hibaüzenet jelenik meg, ha felhasználói beavatkozásra van szükség.
Logger	Osztály, amely megkönnyíti az üzenetek egy adott helyre való naplózását.
NetworkError	Hálózattal kapcsolatos hibákat jelöl
PerformanceClient
PlatformBrokerError	Hibaosztály az MSAL futtatókörnyezeti hibákhoz, amelyek megőrzik a részletes közvetítői információkat
ProtocolUtils	Az OAuth 2.0 protokollspecifikus értékeit segítő osztály
ScopeSet	A ScopeSet osztály hatóköröket hoz létre. A hatókörök kis- és nagybetűket nem érzékenek, egyedi értékek, ezért a JS-ben a Set objektum a leginkább értelme ennek az osztálynak a megvalósítására. Az összes hatókört metszet és egyesítő függvények kisbetűs sztringjeivé alakítja a sztringek egyediségének biztosítása érdekében.
ServerError	Hiba jelenik meg a kiszolgáló kódjával kapcsolatos hiba esetén, például elérhetetlenség esetén.
StubPerformanceClient
UrlString	Url-objektumosztály, amely különböző átalakításokat hajthat végre URL-sztringeken.
TokenCacheContext	Ez az osztálypéldány segít nyomon követni azokat a memóriaváltozásokat, amelyek megkönnyítik az olvasást és az írást az állandó gyorsítótárba

Interfészek

ICrypto	Kódtár által használt kriptográfiai függvények felülete
ILoggerCallback
INetworkModule	Ügyfél hálózati adaptere háttérkérelmek küldéséhez.
IPerformanceClient
IPerformanceMeasurement
IUri	URI-összetevőket leíró felület.
PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

Típusaliasok

AccessTokenEntity	Hozzáférési jogkivonat gyorsítótárának típusa
AccountFilter	Fiók: <home_account_id-environment-realm>><<*>
AccountInfo	Fiókobjektum a következő aláírással: homeAccountId – A fiókobjektum otthoni fiókazonosítója környezet – A kiállító tartománya által képviselt jogkivonatot kibocsátó entitás (pl. login.microsoftonline.com) tenantId – Teljes bérlői vagy szervezeti azonosító, amelyhez ez a fiók tartozik felhasználónév – a fiókot képviselő id_token preferred_username jogcíme localAccountId – A fiókobjektum helyi, bérlőspecifikus fiókazonosítója, amelyet általában örökölt esetekben használnak név – A fiók teljes neve, beleértve a utónevet és a családnevet idToken – nyers azonosító jogkivonat idTokenClaims – Az objektum azonosító jogkivonatból származó jogcímeket tartalmaz nativeAccountId – A felhasználó natív fiókazonosítója tenantProfiles – A bérlőprofil-objektumok térképe minden olyan bérlőhöz, amellyel a fiók hitelesített a böngészőben dataBoundary – A clientInfo-ból kinyert adathatár
ActiveAccountFilters
AppMetadataEntity	Alkalmazás metaadatainak gyorsítótárának típusa
ApplicationTelemetry	Kérelemre küldött telemetriai adatok appName: Egy alkalmazás egyedi sztringneve appVersion: Az alkalmazás verziója az MSAL használatával
AuthenticationResult	A szolgáltató jogkivonatvégpontja által visszaadott eredmény. uniqueId – oid vagy sub jogcím azonosító jogkivonatból tenantId – tid jogcím azonosító jogkivonatból hatókörök – A megfelelő jogkivonathoz érvényesített hatókörök fiók – Az aktuálisan bejelentkezett felhasználó fiókobjektum-ábrázolása idToken – A válasz részeként kapott azonosító jogkivonat idTokenClaims – MSAL-releváns azonosító jogkivonat jogcímei accessToken – A válasz részeként kapott hozzáférési jogkivonat vagy SSH-tanúsítvány fromCache – Logikai hiba, amely azt jelzi, hogy a token a gyorsítótárból származik-e expiresOn – Javascript Date objektum, amely a hozzáférési jogkivonat relatív lejáratát jelöli extExpiresOn – Javascript Date objektum, amely a hozzáférési jogkivonat kiterjesztett relatív lejáratát jelöli kiszolgálókimaradás esetén refreshOn – Javascript Date objektum, amely a hozzáférési jogkivonat frissítéséig eltelt relatív időt jelöli állapot – A felhasználó által a kérelemben átadott érték familyId – Családazonosító azonosítója, amely általában csak frissítési jogkivonatokhoz használatos requestId – A válasz részeként visszaadott kérelemazonosító
AuthorityOptions
AuthorizationCodePayload	A kódválasz-lekérdezési sztring vagy -töredék feldolgozása után visszaadott válasz.
AuthorizeResponse	A /authorize végpont által visszaadott választulajdonságok
AzureCloudOptions	AzureCloudInstance-specifikus beállítások azureCloudInstance – sztringes szám, amely rövid jelölést biztosít a titkos és a nyilvános felhőszolgáltatók számára bérlő – kiépítés a bérlői adatok megadásához
AzureRegion
AzureRegionConfiguration
BaseAuthRequest	BaseAuthRequest authority – A szolgáltató URL-címe, a biztonsági jogkivonat-szolgáltatás (STS), amelyből az MSAL jogkivonatokat szerez be. Alapértelmezett érték: https://login.microsoftonline.com/common. Ha minden kérelemhez ugyanazt a szolgáltatót használja, a szolgáltatónak az ügyfélalkalmazás-objektumra kell beállítania, és nem a kérésre, hogy elkerülje a szolgáltatói végpontok többszöri feloldását. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. authenticationScheme – A lekért jogkivonat típusa. Alapértelmezés szerint a "Tulajdonos". Lehet "pop" vagy "SSH" is. jogcímek – Sztringezett jogcímkérelem, amely az összes /engedélyezési és /token-híváshoz hozzáadódik shrClaims – Sztringezett jogcímobjektum, amely hozzá lesz adva egy aláírt HTTP-kérelemhez shrNonce – A kiszolgáló által létrehozott, titkosított és base64URL kódolású időbélyeg, amely hozzá lesz adva egy aláírt HTTP-kérelemhez. shrOptions – Az aláírt HTTP-kérelem beállításait tartalmazó objektum resourceRequestMethod – HTTP-kérés típusa az erőforrástól való adatkéréshez (pl. "GET", "POST", stb.). A birtoklás igazolására szolgáló folyamatokhoz használatos. resourceRequestUri – URI, amelyhez a jogkivonatot használjuk. A birtoklás igazolására szolgáló folyamatokhoz használatos. sshJwk – Egy SSH-tanúsítvánnyal aláírható nyilvános kulcsot jelképező sztringezett JSON-webkulcs. sshKid – Kulcsazonosító, amely egyedileg azonosítja a fent említett SSH nyilvános kulcsot. azureCloudOptions – Kényelmi sztringek számbavétele a felhasználók számára nyilvános/szuverén felhőazonosítók megadásához requestedClaimsHash – A kért jogcímsztring SHA 256 kivonatsztringje, amelyet egy hozzáférési jogkivonat gyorsítótárkulcsának részeként használnak, hogy a jogkivonatok szűrhetők legyenek a kért jogcímekkel tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése tokenBodyParameters – A /token hívás törzséhez hozzáadott egyéni paraméterek karakterlánc-leképezése storeInCache – Logikai értékeket tartalmazó objektum, amely jelzi, hogy a jogkivonatokat a gyorsítótárban kell-e tárolni (az alapértelmezett érték igaz) scenarioId – Esetazonosító az egyéni felhasználói kérések nyomon követéséhez popKid – Kulcsazonosító a PoP-jogkivonat-kérés nyilvános kulcsának azonosításához embeddedClientId – Beágyazott ügyfélazonosító. Ha meg van adva, a közvetítő ügyfélazonosítója (brk_client_id) és az átirányítási uri (brk_redirect_uri) paraméter a konfiguráció értékeivel van beállítva, felülbírálással a megfelelő további paramétereken, ha vannak. httpMethod – HTTP-metódus a /engedélyezési kérelemhez. A GET alapértelmezett értéke, de post értékre állítható be, ha a kérés törzsparamétereket igényel authorizePostBodyParameters – A /authorize hívás törzséhez hozzáadott egyéni paraméterek sztring-leképezése, ha a httpMethod ÉRTÉKE POST skipBrokerClaims – Igaz és közvetített folyamat használata esetén (például közvetítői paramok vagy embeddedClientId esetén) a konfigurációból származó clientCapabilities ki lesz zárva a jogcímekből; nem közvetített folyamatok esetén figyelmen kívül hagyva.
CacheOptions	Ezzel konfigurálhatja a hitelesítőadat-gyorsítótár beállításait a ClientConfiguration objektumban claimsBasedCachingEnabled – Beállítja, hogy a jogkivonatok gyorsítótárazva legyenek-e a jogcímkivonat alapján. Az alapértelmezett érték false.
CcsCredential
ClientInfo	Ügyfélinformációs objektum, amely a következőből áll: uid: felhasználói azonosító utid: bérlőazonosító xms_tdbr: nem kötelező, csak nem USA-beli bérlők esetén
CommonAuthorizationCodeRequest	A felhasználó által átadott objektum kérése érvényes engedélyezési kód (az OAuth2.0 engedélyezési kód folyamatának második szakasza) cseréjéhez szükséges jogkivonat beszerzéséhez a kiszolgálótól hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. jogcímek – Sztringezett jogcímkérelem, amely az összes /engedélyezési és /token-híváshoz hozzáadódik szolgáltató: - a szolgáltató URL-címe, a biztonsági jogkivonat-szolgáltatás (STS), amelyből az MSAL jogkivonatokat szerez be. Ha a szolgáltató az ügyfélalkalmazás-objektumon van beállítva, ez felülírja ezt az értéket. Az érték felülírása esetén a hatóság ellenőrzése minden alkalommal megtörténik. Ha az összes kérelemhez ugyanazt a szolgáltatót használja, a kérések helyett állítsa be az alkalmazásobjektumot. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. redirectUri – Az alkalmazás átirányítási URI-ja, ahová a szolgáltató átirányítja a felhasználó által megadott hitelesítő adatokat és hozzájárulásokat. Pontosan meg kell egyeznie a portálon regisztrált átirányítási URI-k egyikével kód – A authorization_code, amelyet a felhasználó a folyamat első szakaszában szerzett be. codeVerifier – Ugyanaz a code_verifier, mint a authorization_code beszerzéséhez. Kötelező, ha a PKCE-t az engedélyezési kód megadására vonatkozó kérelemben használták. További információ: PKCE RFC: https://tools.ietf.org/html/rfc7636 resourceRequestMethod – HTTP-kérés típusa az erőforrástól való adatkéréshez (pl. "GET", "POST", stb.). A birtoklás igazolására szolgáló folyamatokhoz használatos. resourceRequestUri – URI, amelyhez a jogkivonatot használjuk. A birtoklás igazolására szolgáló folyamatokhoz használatos. enableSpaAuthCode – Engedélyezi a fürdőengedélyezési kód akkkreditációját (csak bizalmas ügyfelek esetén) tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
CommonAuthorizationUrlRequest	A felhasználó által átadott objektum kérése kód lekéréséhez a kiszolgálóról (az engedélyezési kód megadásának első szakasza) hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. jogcímek – Sztringezett jogcímkérelem, amely az összes /engedélyezési és /token-híváshoz hozzáadódik authority – Annak a szolgáltatónak az URL-címe, amelytől az alkalmazás jogkivonatokat szerez be. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. redirectUri – Az átirányítási URI, ahol hitelesítési válaszokat kaphat az alkalmazás. Pontosan meg kell egyeznie a Azure portálon regisztrált átirányítási URI-k egyikével. extraScopesToConsent – Egy másik erőforrás hatókörei, ha a felhasználónak előzetes hozzájárulásra van szüksége. responseMode – Megadja azt a metódust, amellyel a hitelesítési eredményt elküldheti az alkalmazásnak. Lehet lekérdezés, form_post vagy töredék. Ha a rendszer nem ad át értéket, a lekérdezés alapértelmezés szerint lekérdezhető. codeChallenge – Az engedélyezési kód megadásának védelmére szolgál a Code Exchange (PKCE) kulcsának ellenőrzésével. További információ: PKCE RCF:https://tools.ietf.org/html/rfc7636 codeChallengeMethod – A kód hitelesítőjének kódolására használt módszer a kódkonfigurálási paraméterhez. Lehet "egyszerű" vagy "S256". Ha nincs kizárva, a kódkontrasztot egyszerű szövegnek kell feltételezni. További információ: PKCE RCF: https://tools.ietf.org/html/rfc7636 state – A kérésben szereplő érték, amelyet a jogkivonat válasza is visszaad. A véletlenszerűen létrehozott egyedi érték általában a helyek közötti hamisítási támadások megelőzésére szolgál. Az állapot a felhasználó állapotával kapcsolatos információk kódolására is használható az alkalmazásban a hitelesítési kérelem előtt. parancssor – A szükséges felhasználói beavatkozás típusát jelzi. bejelentkezés: arra kényszeríti a felhasználót, hogy adja meg a hitelesítő adatait a kéréshez, az egyszeri bejelentkezést pedig semmisre ne kapcsolja: biztosítja, hogy a felhasználó ne jelenjen meg interaktív kéréssel. ha a kérés nem hajtható végre egyszeri bejelentkezéssel, a végpont egy interaction_required hibaüzenetet ad vissza: az OAuth-hozzájárulás párbeszédpanelt a felhasználó bejelentkezése után aktiválja, és megkéri a felhasználót, hogy adjon engedélyeket az alkalmazásnak select_account: megszakítja az egyszeri bejelentkezést= a munkamenet összes fiókját vagy az összes megjegyezett fiókot felsoroló fiók kiválasztásával, vagy egy másik fiók létrehozása lehetőséggel: a bejelentkezési élmény no_session helyett a fióklétrehozási felületre irányítja a felhasználót: a felhasználó hitelesítésekor nem olvassa be a meglévő munkamenet-jogkivonatot. A felhasználó sikeres hitelesítése után az EVO nem hoz létre új munkamenetet a felhasználó számára. CSAK BELSŐ HASZNÁLATRA. fiók – GetAccount API-ból beszerzett AccountInfo. Bizonyos forgatókönyvekben login_hint generál, ha a loginHint és az sid params is nincs megadva. loginHint – A bejelentkezési oldal felhasználónév/e-mail-cím mezőjének előre kitölthető a felhasználó számára, ha előre ismeri a felhasználónevet/e-mail-címet. Az alkalmazások gyakran használják ezt a paramétert az újrahitelesítés során, miután már kinyerték a felhasználónevet egy korábbi bejelentkezésből a preferred_username jogcím használatával. sid – Munkamenet-azonosító, a munkamenet egyedi azonosítója. Az azonosító jogkivonatokon választható jogcímként érhető el. domainHint – Tippet ad arról a bérlőről vagy tartományról, amelyet a felhasználónak használnia kell a bejelentkezéshez. A tartománymutató értéke a bérlő regisztrált tartománya. extraQueryParameters – A /authorize híváshoz hozzáadott egyéni lekérdezési paraméterek sztring-sztring-leképezése tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése nonce – Az azonosító jogkivonatában visszaadott kérésben szereplő érték. A véletlenszerűen létrehozott egyedi értékeket általában a visszajátszási támadások enyhítésére használják. resourceRequestMethod – HTTP-kérés típusa az erőforrástól való adatkéréshez (pl. "GET", "POST", stb.). A birtoklás igazolására szolgáló folyamatokhoz használatos. resourceRequestUri – URI, amelyhez a jogkivonatot használjuk. A birtoklás igazolására szolgáló folyamatokhoz használatos.
CommonEndSessionRequest	CommonEndSessionRequest fiók – A rendszer kijelentkezteti a fiókobjektumot. A fiókhoz kapcsolódó összes jogkivonat törlődik. postLogoutRedirectUri – URI a kijelentkezés utáni oldalra való navigáláshoz. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. idTokenHint – A B2C által a kijelentkezés ellenőrzéséhez használt azonosító jogkivonat, ha a szabályzat megköveteli state – A kijelentkezési végpontra irányuló kérésben szereplő érték, amely a lekérdezési sztringben lesz visszaadva a kijelentkezés utáni átirányításkor logoutHint – Egy sztring, amely megadja a kijelentkezett fiókot, hogy kihagyhassa a kiszolgálófiókválasztót a kijelentkezéskor extraQueryParameters – A /authorize híváshoz hozzáadott egyéni lekérdezési paraméterek sztring-sztring-leképezése
CommonRefreshTokenRequest	CommonRefreshTokenRequest hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. jogcímek – Sztringezett jogcímkérelem, amely az összes /engedélyezési és /token-híváshoz hozzáadódik authority – A szolgáltató URL-címe, a biztonsági jogkivonat-szolgáltatás (STS), amelyből az MSAL jogkivonatokat szerez be. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. refreshToken – Egy korábbi kérésből visszaadott frissítési jogkivonat az identitásszolgáltatónak. resourceRequestMethod – HTTP-kérés típusa az erőforrástól való adatkéréshez (pl. "GET", "POST", stb.). A birtoklás igazolására szolgáló folyamatokhoz használatos. resourceRequestUri – URI, amelyhez a jogkivonatot használjuk. A birtoklás igazolására szolgáló folyamatokhoz használatos. forceCache – Kényszerítse az MSAL-t a frissítési jogkivonat-folyamat válaszának gyorsítótárazására, ha nincs fiók a gyorsítótárban. Migrálási forgatókönyvekhez használatos. tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
CommonSilentFlowRequest	A felhasználó által átadott SilentFlow-paraméterek a hitelesítő adatok csendes lekéréséhez hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. jogcímek – Sztringezett jogcímkérelem, amely az összes /engedélyezési és /token-híváshoz hozzáadódik. Ha csendes kérelemben szerepel, a rendszer kihagyja a gyorsítótár-keresést, és frissíti a jogkivonatot. authority – Annak a szolgáltatónak az URL-címe, amelytől az alkalmazás jogkivonatokat szerez be. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. fiók – Fiók entitás a hitelesítő adatok kereséséhez. forceRefresh – A csendes kérelmek kényszerítése hálózati hívások indítására, ha igaz. resourceRequestMethod – HTTP-kérés típusa az erőforrástól való adatkéréshez (pl. "GET", "POST", stb.). A birtoklás igazolására szolgáló folyamatokhoz használatos. resourceRequestUri – URI, amelyhez a jogkivonatot használjuk. A birtoklás igazolására szolgáló folyamatokhoz használatos. tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
CredentialEntity	Hitelesítőadat-gyorsítótár típusa
CredentialFilter	Hitelesítő adatok: home_account_id*>-environment-credential_type-client_id-realm<><><><*>-<target*>-<scheme* <>
ExternalTokenResponse	A külső jogkivonatok gyorsítótárba való betöltéséhez használt válaszobjektum. token_type: A jogkivonat típusértékét jelzi. Az AD Azure csak a Bearer típust támogatja. hatókör: Azok a hatókörök, amelyekre a access_token érvényes. expires_in: Mennyi ideig érvényes a hozzáférési jogkivonat (másodpercben). id_token: JSON webes jogkivonat (JWT). Az alkalmazás dekódolhatja ennek a jogkivonatnak a szegmenseit, hogy információt kérjen a bejelentkezett felhasználóról. refresh_token: OAuth 2.0 frissítési jogkivonat. Az alkalmazás az aktuális hozzáférési jogkivonat lejárata után további hozzáférési jogkivonatokat szerezhet be. access_token: A kért hozzáférési jogkivonat. Az alkalmazás ezzel a jogkivonattal hitelesítheti magát a védett erőforráson, például egy webes API-n. client_info: Ügyfél-információs objektum
IdTokenEntity	Azonosító jogkivonat gyorsítótárának típusa
InProgressPerformanceEvent
LibraryStateObject	Az állapotértékben sztringezett, kódolt és elküldött objektumot meghatározó típus. A következőket tartalmazza: id – a kérés egyedi azonosítója ts – a kérés teljesítésének időbélyege. Annak biztosítására szolgál, hogy a jogkivonat lejárata ne legyen helytelenül kiszámítva. platformState – a platformról küldött sztringérték.
LoggerOptions	Ezzel konfigurálhatja az MSAL által végzett naplózást a konfigurációs objektum naplózási beállításainak konfigurálásával loggerCallback – Visszahívás a naplózóhoz piiLoggingEnabled – Beállítja, hogy engedélyezve van-e a pii-naplózás logLevel – A naplózási szint beállítása correlationId – Beállítja a naplózó által kinyomtatott korrelációs azonosítót
NetworkRequestOptions	A hálózati kérelem API-k által engedélyezett beállítások.
NetworkResponse
OIDCOptions	Az OIDC protokoll mód beállításai.
PerformanceCallbackFunction
PerformanceEvent	A tár által végzett teljesítménymérés, beleértve a kérés és az alkalmazás metaadatait is.
PkceCodes	A PkceCodes típus a PKCE-kód kihívást és ellenőrző párokat tartalmazó objektumok szerkezetét írja le
QueueMeasurement	Üzenetsor-mérés típusa
RefreshTokenEntity	Jogkivonat-gyorsítótár típusának frissítése
RequestStateObject	Az engedélyezési kérelemben a szolgáltatásnak küldött sztringezett és kódolt objektumot meghatározó típus.
RequestThumbprint	Egyedi kérés ujjlenyomatát képviselő típus.
ServerAuthorizationTokenResponse	Deszerializált válaszobjektum a kiszolgáló engedélyezési kódkérelméből. token_type: A jogkivonat típusértékét jelzi. Lehet bearer vagy pop. hatókör: Azok a hatókörök, amelyekre a access_token érvényes. expires_in: Mennyi ideig érvényes a hozzáférési jogkivonat (másodpercben). refresh_in: A jogkivonat megújításának időtartama a lejárattól függetlenül. ext_expires_in: Mennyi ideig érvényes a hozzáférési jogkivonat (másodpercben), ha a kiszolgáló nem válaszol. access_token: A kért hozzáférési jogkivonat. Az alkalmazás ezzel a jogkivonattal hitelesítheti magát a védett erőforráson, például egy webes API-n. refresh_token: OAuth 2.0 frissítési jogkivonat. Az alkalmazás az aktuális hozzáférési jogkivonat lejárata után további hozzáférési jogkivonatokat szerezhet be. id_token: JSON webes jogkivonat (JWT). Az alkalmazás dekódolhatja ennek a jogkivonatnak a szegmenseit, hogy információt kérjen a bejelentkezett felhasználóról. key_id: Egy sztring, amely egyedileg azonosítja a kérelemhez kötött nyilvános kulcsot. Hiba esetén: hiba: Hibakódsztring, amely a előforduló hibatípusok besorolására használható, és a hibákra való reagálásra használható. error_description: Egy adott hibaüzenet, amely segíthet a fejlesztőknek azonosítani a hitelesítési hiba kiváltó okát. error_codes: Az STS-specifikus hibakódok listája, amelyek segíthetnek a diagnosztikában. időbélyeg: A hiba előfordulásának időpontja. trace_id: A kérés egyedi azonosítója, amely segíthet a diagnosztikában. correlation_id: A kérés egyedi azonosítója, amely segíthet az összetevők közötti diagnosztikában. állapot: a hálózati kérelem válaszállapota
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache	Azt szabályozza, hogy a jogkivonatokat a gyorsítótárban kell-e tárolni. Ha hamis értékre van állítva, előfordulhat, hogy a jogkivonatok továbbra is beolvashatók és visszaadhatók, de a rendszer nem gyorsítótárazza a későbbi lekéréshez.
StringDict	Key-Value lekérdezésparamok, extraQueryParams és jogcímek támogatására szolgáló típus
SubMeasurement
SystemOptions	Ezzel konfigurálhatja a tokenmegújítási adatokat a Konfiguráció objektumban tokenRenewalOffsetSeconds – Beállítja a jogkivonat lejárat előtti megújításához szükséges eltolás ablakát
TenantProfile	Fiókadatok, amelyek ugyanazon felhasználó bérlőitől függően változnak
ThrottlingEntity
TokenClaims	Az MSAL által ismert azonosítójogkivonat-jogcímeket leíró típus.
TokenKeys
AppTokenProviderParameters	Bemeneti objektum az IAppTokenProvider bővíthetőségéhez. Az MSAL létrehozza ezt az objektumot, amely az AppTokenProviderResult létrehozásához használható. correlationId – a kérelemhez társított korrelációs azonosító tenantId – az a bérlőazonosító, amelyhez a jogkivonatot meg kell adni hatókörök – azok a hatókörök, amelyekhez a jogkivonatot meg kell adni jogcímek – minden olyan további jogcím, amelyet a jogkivonatnak teljesítenie kell
AppTokenProviderResult	Kimeneti objektum az IAppTokenProvider bővíthetőségéhez. accessToken – a tényleges hozzáférési jogkivonat, általában JWT formátumban, amely megfelel az AppTokenProviderParameters kérelemadatoknak expiresInSeconds – a jogkivonatok lejárati ideje másodpercben. Hasonló az AAD-jogkivonat-válasz "expires_in" mezőjéhez. refreshInSeconds – mennyi ideig tart a jogkivonat proaktív frissítése. Hasonló az AAD-jogkivonat-válasz "refresh_in" mezőjéhez.
ClientAssertion	Ügyfélérvényesítési hitelesítő adatok bizalmas ügyfelek számára
ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest	CommonClientCredentialRequest hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. authority – A szolgáltató URL-címe, a biztonsági jogkivonat-szolgáltatás (STS), amelyből az MSAL jogkivonatokat szerez be. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. skipCache – Kihagyhatja a tokengyorsítótár keresését, és új jogkivonat beszerzésére kényszerítheti a szolgáltatót. Alapértelmezés szerint hamis. preferredAzureRegionOptions – A felhasználó által előnyben részesített Azure-régió beállításai tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
CommonDeviceCodeRequest	Az Oauth2-eszköz kódfolyamatának paraméterei. hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. szolgáltató: - a szolgáltató URL-címe, a biztonsági jogkivonat-szolgáltatás (STS), amelyből az MSAL jogkivonatokat szerez be. Ha a szolgáltató az ügyfélalkalmazás-objektumon van beállítva, ez felülírja ezt az értéket. Az érték felülírása esetén a hatóság ellenőrzése minden alkalommal megtörténik. Ha az összes kérelemhez ugyanazt a szolgáltatót használja, a kérések helyett állítsa be az alkalmazásobjektumot. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. deviceCodeCallback – Eszközkód-választ tartalmazó visszahívás. Az üzenetet meg kell jeleníteni a végfelhasználónak. A végfelhasználó ezután navigálhat a verification_uri, beírhatja a user_code és a bemeneti hitelesítő adatokat. cancel – Logikai érték az eszközkódvégpont lekérdezésének megszakításához. Míg a felhasználó egy külön eszközön hitelesít, az MSAL lekérdezi a biztonsági jogkivonat-szolgáltatás jogkivonatvégpontjait az eszközkód-válaszban megadott időtartamhoz (általában 15 perc). A lekérdezés leállításához és a kérés visszavonásához állítsa be a cancel=true értéket. resourceRequestMethod – HTTP-kérés típusa az erőforrástól való adatkéréshez (pl. "GET", "POST", stb.). A birtoklás igazolására szolgáló folyamatokhoz használatos. resourceRequestUri – URI, amelyhez a jogkivonatot használjuk. A birtoklás igazolására szolgáló folyamatokhoz használatos. időtúllépés – Időtúllépési időszak másodpercben, amelyet a felhasználó kifejezetten konfigurál az eszközkódvégpont lekérdezéséhez. Ennek az időszaknak a végén; feltéve, hogy az eszközkód még nem járt le; az eszközkód lekérdezése le van állítva, és a kérés megszakadt. Az eszközkód lejárati ideje mindig elsőbbséget élvez a megadott időszakkal szemben. extraQueryParameters – A lekérdezési sztringhez hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
CommonOnBehalfOfRequest	hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. authority – A szolgáltató URL-címe, a biztonsági jogkivonat-szolgáltatás (STS), amelyből az MSAL jogkivonatokat szerez be. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. oboAssertion – A középső szintű API-nak küldött hozzáférési jogkivonat. Ennek a jogkivonatnak rendelkeznie kell az alkalmazás célközönségével, amely ezt az OBO-kérést készíti. skipCache – Kihagyhatja a tokengyorsítótár keresését, és új jogkivonat beszerzésére kényszerítheti a szolgáltatót. Alapértelmezés szerint hamis. tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
CommonUsernamePasswordRequest	CommonUsernamePassword paramétereket adott át a felhasználó a hitelesítő adatok lekéréséhez Megjegyzés: A legújabb OAuth 2.0 biztonsági ajánlott eljárás teljes mértékben letiltja a jelszó megadását. Ez a folyamat hozzáadva a belső teszteléshez. hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. jogcímek – Sztringezett jogcímkérelem, amely az összes /engedélyezési és /token-híváshoz hozzáadódik. Ha csendes kérelemben szerepel, a rendszer kihagyja a gyorsítótár-keresést, és frissíti a jogkivonatot. authority – Annak a szolgáltatónak az URL-címe, amelytől az alkalmazás jogkivonatokat szerez be. correlationId – Egyedi GUID-készlet kérésenként a kérések végpontok közötti nyomon követéséhez telemetriai célokra. felhasználónév – az ügyfél felhasználóneve jelszó – hitelesítő adatok tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
DeviceCodeResponse	A biztonsági jogkivonat szolgáltatás eszközkódvégpontja által visszaadott DeviceCode az eszközkód-folyamathoz szükséges információkat tartalmazza. userCode: olyan kód, amelyet a felhasználónak meg kell adnia az ellenőrző URI hitelesítésekor deviceCode: kód, amelyet a hozzáférési jogkivonatra vonatkozó kérésnek tartalmaznia kell verificationUri: URI, ahol a felhasználó hitelesíthet expiresIn: az eszközkód lejárati ideje másodpercben intervallum: az az intervallum, amelyen az STS-t le kell kérdezni üzenet: üzenet, amelyet meg kell jeleníteni a felhasználónak
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

Enumerációk

LogLevel	Naplóüzenetek szintje.
PerformanceEventStatus	A teljesítményesemény állapota.
PerformanceEvents	Azon műveletek számbavétele, amelyeket a PerformanceClient mér a teljesítményük alapján.

Függvények

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)
buildClientInfo(string, (input: string) => string)	Ügyfélinformációs objektum kiszolgálói clientInfo sztringből történő létrehozásához használható függvény
buildClientInfoFromHomeAccountId(string)	Ügyfél-információs objektum létrehozása a gyorsítótárazott homeAccountId sztringből
buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)	Bérlői profil létrehozása
createAuthError(string, string)
createCacheError(unknown)	Segédfüggvény böngészőhibák gyorsítótárazási objektumban való körbefuttatásához
createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)	InteractionRequiredAuthError létrehozása
createNetworkError(AuthError, number, Record<string, string>, Error)	NetworkError-objektum létrehozása sikertelen hálózati kérelemhez
formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)	Lekéri a tenantId azonosítót az elérhető azonosítójogkivonat-jogcímekből, hogy hitelesítőadat-tartományként legyen beállítva a következő elsőbbséget élvezve: tid – ha a jogkivonatot egy Azure AD-bérlői azonosítóból szerezték be, jelen lesz tfp – ha a jogkivonat egy modern B2C-bérlői tfp-ből származik, jelen kell lennie acr – ha a jogkivonatot egy örökölt B2C-bérlői acr-ből szerezték be, a kis- és nagybetűk közötti összehasonlítási követelményeknek megfelelően kisbetűvel kell jelen lennie
tenantIdMatchesHomeTenant(string, string)	Igaz értéket ad vissza, ha a tenantId megegyezik a homeAccountId utid részével
updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)	A bérlőspecifikus fiókadatokra cseréli az átadott azonosító jogkivonat jogcímeiből származó bérlői profilonként eltérő fiókadatokat

Változók

AADAuthorityConstants	AAD-szolgáltatóhoz kapcsolódó sztringállandók
AuthenticationScheme	A hitelesítési kérelem típusa
AuthorityType	Az MSAL által támogatott szolgáltatótípusok.
AzureCloudInstance
CacheAccountType	Fióktípusok a Gyorsítótárban
CacheOutcome	Megadja a hozzáférési jogkivonat identitásszolgáltatótól való lekérésének okát
CacheType	Az összes gyorsítótártípus egyesítése
CcsCredentialType
ClaimsRequestKeys	Jogcímkérelmek kulcsai
CredentialType	A gyorsítótárban tárolt hitelesítő adattípus
EncodingTypes
GrantType	engedélyezett grant_type
HeaderNames	Fejlécnevek kérése
HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType	A response_type engedélyezett értékei
PasswordGrantConstants	Jelszó megadásának paraméterei
PersistentCacheKeys	Állandó gyorsítótárkulcsok MSAL, amelyek a felhasználó bejelentkezése közben maradnak.
ProtocolMode	Az MSAL által támogatott protokollmódok.
ResponseMode	engedélyezett értékek response_mode
ServerResponseType	kiszolgáló választípusának engedélyezett értékei
AuthErrorMessage	Az AuthErrorMessage osztály a hibakódok és üzenetek által használt sztringállandókat tartalmazza.
ClientAuthErrorMessage	Hibakódok és üzenetek által használt sztringállandók.
ClientConfigurationErrorMessage	ClientConfigurationErrorMessage osztály, amely hibakódok és üzenetek által használt sztringállandókat tartalmaz.
CodeChallengeMethodValues	a codeVerifier engedélyezett értékei
Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage	Az SDK által definiált interakcióhoz szükséges hibák
OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue	úgy tekintettük, hogy a kérésben sztring helyett ez az "enum" érték szerepel, de úgy tűnik, hogy az elmúlt néhány évben folyamatosan változó parancssori értékek engedélyezett listája. Egyes belső partnerek esetében is vannak nem dokumentált parancssori értékek, ezért az "enum" helyett az általános "sztring" típust kell választani
StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants	Szabályozáshoz kapcsolódó állandók
version

Függvény adatai

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)

function buildAccountToCache(cacheStorage: CacheManager, authority: Authority, homeAccountId: string, base64Decode: (input: string) => string, correlationId: string, idTokenClaims?: TokenClaims, clientInfo?: string, environment?: string, claimsTenantId?: null | string, authCodePayload?: AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): AccountEntity

Paraméterek

cacheStorage

CacheManager

authority

Authority

homeAccountId

string

base64Decode

(input: string) => string

correlationId

string

idTokenClaims

TokenClaims

clientInfo

string

environment

string

claimsTenantId

null | string

authCodePayload

AuthorizationCodePayload

nativeAccountId

string

logger

Logger

Válaszok

AccountEntity

buildClientInfo(string, (input: string) => string)

Ügyfélinformációs objektum kiszolgálói clientInfo sztringből történő létrehozásához használható függvény

function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo

Paraméterek

rawClientInfo

string

base64Decode

(input: string) => string

Válaszok

ClientInfo

buildClientInfoFromHomeAccountId(string)

Ügyfél-információs objektum létrehozása a gyorsítótárazott homeAccountId sztringből

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Paraméterek

homeAccountId

string

Válaszok

ClientInfo

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions

Paraméterek

authOptions

Partial<AuthorityOptions>

Válaszok

StaticAuthorityOptions

buildTenantProfile(string, string, string, TokenClaims)

Bérlői profil létrehozása

function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile

Paraméterek

homeAccountId

string

A fiókobjektum otthoni fiókazonosítója

localAccountId

string

A fiókobjektum helyi fiókazonosítója

tenantId

string

Teljes bérlői vagy szervezeti azonosító, amelyhez ez a fiók tartozik

idTokenClaims

TokenClaims

Jogcímek az azonosító jogkivonatából

Válaszok

TenantProfile

createAuthError(string, string)

function createAuthError(code: string, additionalMessage?: string): AuthError

Paraméterek

code

string

additionalMessage

string

Válaszok

AuthError

createCacheError(unknown)

Segédfüggvény böngészőhibák gyorsítótárazási objektumban való körbefuttatásához

function createCacheError(e: unknown): CacheError

Paraméterek

e

unknown

Válaszok

CacheError

createClientAuthError(string, string)

function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError

Paraméterek

errorCode

string

additionalMessage

string

Válaszok

ClientAuthError

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Paraméterek

errorCode

string

Válaszok

ClientConfigurationError

createInteractionRequiredAuthError(string)

InteractionRequiredAuthError létrehozása

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Paraméterek

errorCode

string

Válaszok

InteractionRequiredAuthError

createNetworkError(AuthError, number, Record<string, string>, Error)

NetworkError-objektum létrehozása sikertelen hálózati kérelemhez

function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError

Paraméterek

error

AuthError

Hiba a hívónak való visszadobáskor

httpStatus

number

A hálózati kérelem állapotkódja

responseHeaders

Record<string, string>

A hálózati kérelem válaszfejlécei, ha elérhetők

additionalError

Error

Válaszok

NetworkError

NetworkError objektum

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Paraméterek

authorityUri

string

Válaszok

string

getRequestThumbprint(string, BaseAuthRequest, string)

function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint

Paraméterek

clientId

string

request

BaseAuthRequest

homeAccountId

string

Válaszok

RequestThumbprint

getTenantIdFromIdTokenClaims(TokenClaims)

Lekéri a tenantId azonosítót az elérhető azonosítójogkivonat-jogcímekből, hogy hitelesítőadat-tartományként legyen beállítva a következő elsőbbséget élvezve:

1. tid – ha a jogkivonatot egy Azure AD-bérlői azonosítóból szerezték be, jelen lesz
2. tfp – ha a jogkivonat egy modern B2C-bérlői tfp-ből származik, jelen kell lennie
3. acr – ha a jogkivonatot egy örökölt B2C-bérlői acr-ből szerezték be, a kis- és nagybetűk közötti összehasonlítási követelményeknek megfelelően kisbetűvel kell jelen lennie

function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

Paraméterek

idTokenClaims

TokenClaims

Válaszok

string | null

tenantIdMatchesHomeTenant(string, string)

Igaz értéket ad vissza, ha a tenantId megegyezik a homeAccountId utid részével

function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean

Paraméterek

tenantId

string

homeAccountId

string

Válaszok

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

A bérlőspecifikus fiókadatokra cseréli az átadott azonosító jogkivonat jogcímeiből származó bérlői profilonként eltérő fiókadatokat

function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo

Paraméterek

baseAccountInfo

AccountInfo

tenantProfile

TenantProfile

idTokenClaims

TokenClaims

idTokenSecret

string

Válaszok

AccountInfo

Változó részletei

AADAuthorityConstants

AAD-szolgáltatóhoz kapcsolódó sztringállandók

AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

Típus

{ COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

AuthenticationScheme

A hitelesítési kérelem típusa

AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

Típus

{ BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

AuthorityType

Az MSAL által támogatott szolgáltatótípusok.

AuthorityType: { Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

Típus

{ Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

AzureCloudInstance

AzureCloudInstance: { AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

Típus

{ AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

CacheAccountType

Fióktípusok a Gyorsítótárban

CacheAccountType: { ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

Típus

{ ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

CacheOutcome

Megadja a hozzáférési jogkivonat identitásszolgáltatótól való lekérésének okát

CacheOutcome: { CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

Típus

{ CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

CacheType

Az összes gyorsítótártípus egyesítése

CacheType: { ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

Típus

{ ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

CcsCredentialType

CcsCredentialType: { HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

Típus

{ HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

ClaimsRequestKeys

Jogcímkérelmek kulcsai

ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

Típus

{ ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

CredentialType

A gyorsítótárban tárolt hitelesítő adattípus

CredentialType: { ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

Típus

{ ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

EncodingTypes

EncodingTypes: { BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

Típus

{ BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

GrantType

engedélyezett grant_type

GrantType: { AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

Típus

{ AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

HeaderNames

Fejlécnevek kérése

HeaderNames: { AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

Típus

{ AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

HttpMethod

HttpMethod: { GET: "GET", POST: "POST" }

Típus

{ GET: "GET", POST: "POST" }

HttpStatus

HttpStatus: { BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

Típus

{ BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

JsonWebTokenTypes

JsonWebTokenTypes: { Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

Típus

{ Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

OAuthResponseType

A response_type engedélyezett értékei

OAuthResponseType: { CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

Típus

{ CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

PasswordGrantConstants

Jelszó megadásának paraméterei

PasswordGrantConstants: { password: "password", username: "username" }

Típus

{ password: "password", username: "username" }

PersistentCacheKeys

Állandó gyorsítótárkulcsok MSAL, amelyek a felhasználó bejelentkezése közben maradnak.

PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

Típus

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

ProtocolMode

Az MSAL által támogatott protokollmódok.

ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

Típus

{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

ResponseMode

engedélyezett értékek response_mode

ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

Típus

{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

ServerResponseType

Figyelmeztetés

Ez az API már elavult.

Use ResponseMode instead

kiszolgáló választípusának engedélyezett értékei

ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }

Típus

{ FRAGMENT: "fragment", QUERY: "query" }

AuthErrorMessage

Figyelmeztetés

Ez az API már elavult.

Use AuthErrorCodes instead

Az AuthErrorMessage osztály a hibakódok és üzenetek által használt sztringállandókat tartalmazza.

AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

Típus

{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

ClientAuthErrorMessage

Figyelmeztetés

Ez az API már elavult.

Use ClientAuthErrorCodes instead

Hibakódok és üzenetek által használt sztringállandók.

ClientAuthErrorMessage: { DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

Típus

{ DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

ClientConfigurationErrorMessage

Figyelmeztetés

Ez az API már elavult.

Use ClientConfigurationErrorCodes instead

ClientConfigurationErrorMessage osztály, amely hibakódok és üzenetek által használt sztringállandókat tartalmaz.

ClientConfigurationErrorMessage: { authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

Típus

{ authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

CodeChallengeMethodValues

a codeVerifier engedélyezett értékei

CodeChallengeMethodValues: { PLAIN: string, S256: string }

Típus

{ PLAIN: string, S256: string }

Constants

Constants: { AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

Típus

{ AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

DEFAULT_CRYPTO_IMPLEMENTATION

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

Típus

ICrypto

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Típus

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

Típus

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

Típus

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

Típus

ReadonlySet<string>

InteractionRequiredAuthErrorMessage

Figyelmeztetés

Ez az API már elavult.

Use InteractionRequiredAuthErrorCodes instead

Az SDK által definiált interakcióhoz szükséges hibák

InteractionRequiredAuthErrorMessage: { bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

Típus

{ bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

Típus

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

Típus

86400000

PromptValue

úgy tekintettük, hogy a kérésben sztring helyett ez az "enum" érték szerepel, de úgy tűnik, hogy az elmúlt néhány évben folyamatosan változó parancssori értékek engedélyezett listája. Egyes belső partnerek esetében is vannak nem dokumentált parancssori értékek, ezért az "enum" helyett az általános "sztring" típust kell választani

PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

Típus

{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

Típus

INetworkModule

THE_FAMILY_ID

THE_FAMILY_ID: "1"

Típus

"1"

ThrottlingConstants

Szabályozáshoz kapcsolódó állandók

ThrottlingConstants: { DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

Típus

{ DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

version

version: "15.17.0"

Típus

"15.17.0"