@azure/msal-node package

Osztályok

AuthError	A MSAL.js könyvtár által létrehozott általános hibaosztály.
ClientApplication	Az összes ClientApplication alapszintű absztrakt osztálya – nyilvános és bizalmas
ClientAssertion	A bizalmas ügyfélfolyamatokban használt jwt-bearer típusú ügyfélmegfelelőség
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.
ClientCredentialClient	OAuth2.0 ügyfél hitelesítő adatainak megadása
ConfidentialClientApplication	Ez az osztály a bizalmas ügyfélalkalmazások (webApp, webAPI) jogkivonatainak beszerzésére szolgál. A bizalmas ügyfélalkalmazások szükség szerint konfigurálják az alkalmazás titkos kulcsait, az ügyféltanúsítványokat és -állításokat
CryptoProvider	Ez az osztály implementálja az MSAL-csomópont titkosítási felületét, amely lehetővé teszi, hogy alap64 kódolást és dekódolást végezzen, kriptográfiailag véletlenszerű GRAFIKUS GUID-ket generáljon, és implementálja a Proof Key for Code Exchange specifikációit az OAuth Authorization Code Flow-hoz PKCE használatával (rfc itt: https://tools.ietf.org/html/rfc7636).
DeviceCodeClient	OAuth2.0 Eszközkód-ügyfél
DistributedCachePlugin	Gyorsítótár beépülő modul, amely szerializálja az adatokat a gyorsítótárba, és deszerializálja az adatokat a gyorsítótárból
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.
ManagedIdentityApplication	Osztály felügyelt identitás inicializálásához és a szolgáltatás azonosításához
OnBehalfOfClient	Be-Behalf-Of ügyfél
PublicClientApplication	Ez az osztály nyilvános ügyfélalkalmazások (asztali, mobil) jogkivonatainak beszerzésére szolgál. A nyilvános ügyfélalkalmazások nem megbízhatók az alkalmazás titkos kulcsainak biztonságos tárolásához, ezért csak a felhasználó nevében kérhetnek jogkivonatokat.
ServerError	Hiba jelenik meg a kiszolgáló kódjával kapcsolatos hiba esetén, például elérhetetlenség esetén.
TokenCache	Memóriabeli tokengyorsítótár-kezelő
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
UsernamePasswordClient	Oauth2.0 Jelszóátadási ügyfél megjegyzése: Csak a nyilvános ügyfeleket támogatjuk jelszó megadásához és tisztán tesztelési célokra

Interfészek

IAppTokenProvider
ICacheClient	A gettert és a settert meghatározó gyorsítótár felülete
ICachePlugin
IConfidentialClientApplication	A nyilvános API-aláírásokat meghatározó ConfidentialClientApplication osztály felülete
ILoopbackClient	A LoopbackClient interfésze lehetővé teszi az alapértelmezett visszacsatolási kiszolgáló egyéni implementációra való cseréjét.
INativeBrokerPlugin
INetworkModule	Ügyfél hálózati adaptere háttérkérelmek küldéséhez.
IPartitionManager	A gyorsítótárban lévő identitásadatok kulcsainak lekérésére szolgáló lekérési metódusokat meghatározó felület
IPublicClientApplication	A nyilvános API-aláírásokat meghatározó PublicClientApplication osztály felülete
ISerializableTokenCache
ITokenCache	Az ügyfél tokengyorsítótár-felülete, amely hozzáférést biztosít a gyorsítótár API-khoz

Típusaliasok

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
AppTokenProviderParameters	Az IAppTokenProvider bővíthetőségének bemeneti objektuma. 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árat előtti hossza 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.
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ó
AuthorizationCodePayload	A kódválasz-lekérdezési sztring vagy -töredék feldolgozása után visszaadott válasz.
AuthorizationCodeRequest	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. Ennek pontosan meg kell egyeznie a portálon regisztrált átirányítási URI-k egyikével. tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése 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 state – A felhasználó által gyorsítótárazott és a kiszolgálónak küldött egyedi GUID a folyamat első szakaszában. Ezt a sztringet a kiszolgáló küldi vissza az engedélyezési kóddal. A rendszer ezután összehasonlítja a felhasználó által gyorsítótárazott állapotot a kiszolgálótól kapott állapottal a CSRF-támadások kockázatának csökkentése érdekében. Lásd a(z) https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.
AuthorizationUrlRequest	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 igazolásával. 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és helyett a fióklétrehozás felületére irányítja a felhasználót 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.
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
BrokerOptions	Ezzel konfigurálhatja az alábbi közvetítői beállításokat: nativeBrokerPlugin – Natív közvetítő implementáció (msal-node-extensionsből kell importálni) Megjegyzés: Ezek a beállítások csak az engedélyezési kódfolyamatot használó PublicClientApplications esetében érhetők el
CacheKVStore	Kulcsértéktár a memóriabeli gyorsítótárhoz
CacheOptions	Ezzel konfigurálhatja az alábbi gyorsítótár-konfigurációs beállításokat: cachePlugin – Beépülő modul a tokengyorsítótár lemezre való olvasásához és írásához.
ClientAssertionCallback
ClientCredentialRequest	CommonClientCredentialRequest hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. Általában csak egyetlen erőforrás alapértelmezett hatókörét tartalmazza. Lásd: https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc#the-default-scope 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. clientAssertion – Egy helyességi sztring vagy visszahívási függvény, amely egy helyességi sztringet ad vissza (mindkettő Base64Url-kódolású aláírt JWT-k) az ügyfél hitelesítő adatainak folyamatában tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
Configuration	A konfigurációs objektum használata az MSAL konfigurálásához és az ügyfélalkalmazás-objektum inicializálásához hitelesítés: itt konfigurálhatja az olyan hitelesítési elemeket, mint a clientID, a hitelesítéshez használt szolgáltató az Microsoft Identity Platformon közvetítő: itt konfigurálhatja a közvetítői beállításokat gyorsítótár: itt konfigurálja a gyorsítótár helyét rendszer: itt konfigurálhatja a hálózati ügyfelet, a naplózót telemetria: itt konfigurálhatja a telemetriai beállításokat
DeviceCodeRequest	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. extraQueryParameters – A lekérdezési sztringhez hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése
IdTokenClaims	Az MSAL által ismert azonosítójogkivonat-jogcímeket leíró típus.
InMemoryCache	Időszakos típus a memóriabeli adatobjektumok meghatározott típusok kezeléséhez
InteractiveRequest	A felhasználó által átadott objektum kérése a acquireTokenInteractive API konfigurálásához openBrowser – Függvény egy böngészőpéldány megnyitásához a felhasználó rendszerében. hatókörök – Azon hatókörök tömbje, amelyhez az alkalmazás hozzáférést kér. successTemplate: – A megnyitott böngészőpéldányon a sikeres jogkivonat-beszerzéskor megjelenítendő sablon. errorTemplate – A megnyitott böngészőpéldányon a jogkivonatok beszerzésének sikertelensége esetén megjelenítendő sablon. windowHandle – A natív közvetítőfolyamatokban használatos a natív közvetítőablak megfelelő szülőjeként loopbackClient – A visszacsatolási kiszolgáló egyéni implementációja az engedélyezési kód válaszának figyeléséhez.
JsonCache	A gyorsítótár formátuma az alkalmazás példányosítása során a konfigurációnak megadott gyorsítótár-blobból olvasva
ManagedIdentityConfiguration
ManagedIdentityIdParams
ManagedIdentityRequestParams	ManagedIdentityRequest jogcímek – sztringes jogcímkérelem, amely annak meghatározására szolgál, hogy a gyorsítótárat ki kell-e hagyni forceRefresh – a felügyelt identitáskérések kényszerítése a gyorsítótár kihagyására és hálózati hívások indítására, ha igaz erőforrás – a védett API eléréséhez kért erőforrás. Ennek "ResourceIdUri" vagy "ResourceIdUri/.default" formátumúnak kell lennie. Például https://management.azure.net Microsoft Graph esetében:https://graph.microsoft.com/.default
NetworkRequestOptions	A hálózati kérelem API-k által engedélyezett beállítások.
NetworkResponse
NodeAuthOptions	clientId – Az alkalmazás ügyfélazonosítója. szolgáltató – A hatóság URL-címe. Ha nincs beállítva érték, az alapértelmezett érték a következő.https://login.microsoftonline.com/common knownAuthorities – A B2C és az ADFS Azure szükséges. Az ügyfélalkalmazásban használt összes hatóság. Csak a hatóság gazdagépét szabad átadni. clientSecret – Titkos sztring, amelyet az alkalmazás használ a jogkivonat kérésekor. Csak bizalmas ügyfélalkalmazásokban használható. Az Azure alkalmazásregisztrációs portálon hozható létre. clientAssertion – Egy olyan ClientAssertion objektum, amely egy helyességi sztringet vagy egy visszahívási függvényt tartalmaz, amely egy olyan helyességi sztringet ad vissza, amelyet az alkalmazás a jogkivonat kérésekor használ, valamint az állítás típusát (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Csak bizalmas ügyfélalkalmazásokban használható. clientCertificate – Tanúsítvány, amelyet az alkalmazás a jogkivonat kérésekor használ. Csak bizalmas ügyfélalkalmazásokban használható. A tanúsítvány hexán kódolt X.509 SHA-1 vagy SHA-256 ujjlenyomatát, valamint a PEM kódolású titkos kulcsot (a sztringnek tartalmaznia kell -----BEGIN TITKOS KULCSOT----- ... -----END PRIVÁT KULCSOT----- ) protocolMode – Enum, amely a msal által követett protokollt jelöli. A megfelelő végpontok konfigurálásához használatos. skipAuthorityMetadataCache – A helyi metaadat-gyorsítótár használatát jelző jelző a szolgáltató inicializálása során. Alapértelmezés szerint hamis. encodeExtraQueryParams – Egy jelző, amely meghatározza, hogy a kérés URL-címében további lekérdezési paramétereket kódoljon-e. Alapértelmezés szerint hamis.
NodeSystemOptions	Típus a naplózó és a HTTP-ügyfél beállításainak konfigurálásához logger – A Naplózó objektum inicializálására szolgál; TEENDŐ: A naplózó adatainak kibontása vagy a naplózó dokumentációjára mutató hivatkozás networkClient – Http-ügyfél, amely az összes http-lekéréshez és -küldéshez használható. Alapértelmezés szerint az MSAL alapértelmezett HTTP-ügyfelet használja.
NodeTelemetryOptions
OnBehalfOfRequest	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
RefreshTokenRequest	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. tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése 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.
SerializedAccessTokenEntity	Hozzáférési jogkivonat hitelesítő adatainak típusa
SerializedAccountEntity	Számla típusa
SerializedAppMetadataEntity	AppMetadata típusa
SerializedIdTokenEntity	Idtoken hitelesítő adatok típusa
SerializedRefreshTokenEntity	Jogkivonat hitelesítő adatainak frissítése
SignOutRequest
SilentFlowRequest	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. tokenQueryParameters – A /token híváshoz hozzáadott egyéni lekérdezési paraméterek karakterlánc-leképezése 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.
UsernamePasswordRequest	A felhasználónév-jelszónak a felhasználó által átadott paraméterei 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

Enumerációk

LogLevel

Naplóüzenetek szintje.

Változók

AzureCloudInstance
ManagedIdentitySourceNames	Felügyelt identitás forrásnevei
ProtocolMode	Az MSAL által támogatott protokollmódok.
ResponseMode	engedélyezett értékek response_mode
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.
InteractionRequiredAuthErrorMessage	Az SDK által definiált interakcióhoz szükséges hibák
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.
version

Változó részletei

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" }

ManagedIdentitySourceNames

Felügyelt identitás forrásnevei

ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }

Típus

{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }

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" }

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 } }

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 } }

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 }

version

version: "3.8.10"

Típus

"3.8.10"