@azure/msal-node package

Třídy

AuthError	Obecná třída chyby vyvolaná knihovnou MSAL.js
ClientApplication	Základní abstraktní třída pro všechny ClientApplications – veřejné a důvěrné
ClientAssertion	Klientský kontrolní výraz typu jwt-bearer používaný v důvěrných tocích klientů
ClientAuthError	Chyba vyvolaná v případě, že v kódu klienta spuštěném v prohlížeči došlo k chybě.
ClientConfigurationError	Při konfiguraci knihovny MSAL.js došlo k chybě.
ClientCredentialClient	Udělení přihlašovacích údajů klienta OAuth2.0
ConfidentialClientApplication	Tato třída se používá k získání tokenů pro důvěrné klientské aplikace (webApp, webAPI). Důvěrné klientské aplikace nakonfigurují tajné kódy aplikací, klientské certifikáty nebo kontrolní výrazy podle potřeby.
CryptoProvider	Tato třída implementuje kryptografické rozhraní uzlu MSAL, které umožňuje provádět kódování a dekódování base64, generování kryptograficky náhodných identifikátorů GUID a implementaci ověřovacího klíče pro kód Exchange specifikace pro tok autorizačního kódu OAuth pomocí PKCE (rfc zde: https://tools.ietf.org/html/rfc7636).
DeviceCodeClient	Klient kódu zařízení OAuth2.0
DistributedCachePlugin	Modul plug-in mezipaměti, který serializuje data do mezipaměti a deserializuje data z mezipaměti
InteractionRequiredAuthError	Při vyžadování interakce uživatele došlo k chybě.
Logger	Třída, která usnadňuje protokolování zpráv na určité místo.
ManagedIdentityApplication	Třída pro inicializaci spravované identity a identifikaci služby
OnBehalfOfClient	On-Behalf-Of client
PublicClientApplication	Tato třída se používá k získání tokenů pro veřejné klientské aplikace (desktop, mobilní zařízení). Veřejné klientské aplikace nejsou důvěryhodné pro bezpečné ukládání tajných kódů aplikací, a proto mohou požadovat pouze tokeny v názvu uživatele.
ServerError	Chyba vyvolaná v případě, že dojde k chybě s kódem serveru, například nedostupnost.
TokenCache	Správce mezipaměti tokenů v paměti
TokenCacheContext	Tato instance třídy pomáhá sledovat změny paměti, které usnadňují rozhodování o čtení a zápisu do trvalé mezipaměti.
UsernamePasswordClient	Oauth2.0 Password grant client Poznámka: Podporujeme pouze veřejné klienty pro udělení hesla a čistě testovací účely.

Rozhraní

IAppTokenProvider
ICacheClient	Rozhraní pro mezipaměť, která definuje getter a setter
ICachePlugin
IConfidentialClientApplication	Rozhraní pro třídu ConfidentialClientApplication definující podpisy veřejného rozhraní API
ILoopbackClient	Rozhraní pro LoopbackClient umožňující nahradit výchozí server zpětné smyčky vlastní implementací.
INativeBrokerPlugin
INetworkModule	Klientské síťové rozhraní pro odesílání požadavků back-endu
IPartitionManager	Rozhraní, které definuje metody getter pro získání klíčů používaných k datům identity v mezipaměti
IPublicClientApplication	Rozhraní pro třídu PublicClientApplication definující podpisy veřejného rozhraní API
ISerializableTokenCache
ITokenCache	Rozhraní mezipaměti tokenů pro klienta, které poskytuje přístup k rozhraním API mezipaměti

Aliasy typu

AccountInfo	Objekt účtu s následujícím podpisem: homeAccountId – identifikátor domovského účtu pro tento objekt účtu environment – entita, která vydala token reprezentovaný doménou vystavitele (např. login.microsoftonline.com) tenantId – Úplné ID tenanta nebo organizace, ke kterému tento účet patří uživatelské jméno – preferred_username deklarace identity id_token, která představuje tento účet localAccountId – identifikátor místního účtu specifického pro tenanta pro tento objekt účtu, obvykle používaný ve starších případech jméno – celé jméno účtu, včetně jména a jména rodiny idToken – nezpracovaný token ID idTokenClaims – Objekt obsahuje deklarace identity z tokenu ID nativeAccountId – ID nativního účtu uživatele tenantProfiles – mapa objektů profilu tenanta pro každého tenanta, u kterého se účet ověřil v prohlížeči dataBoundary – hranice dat extrahovaná z clientInfo
AppTokenProviderParameters	Vstupní objekt pro rozšiřitelnost IAppTokenProvider. MSAL vytvoří tento objekt, který lze použít k vytvoření AppTokenProviderResult. correlationId – ID korelace přidružené k požadavku tenantId – ID tenanta, pro kterého musí být token poskytnut scopes – obory, pro které musí být token poskytnut deklarace identity – všechny další deklarace identity, které musí token splňovat
AppTokenProviderResult	Výstupní objekt pro rozšiřitelný objekt IAppTokenProvider. accessToken – skutečný přístupový token, obvykle ve formátu JWT, který splňuje data požadavku AppTokenProviderParameters expiresInSeconds – jak dlouho mají tokeny před vypršením platnosti v sekundách. Podobá se poli "expires_in" v odpovědi tokenu AAD. refreshInSeconds – jak dlouho má token před aktivní aktualizací. Podobá se poli "refresh_in" v odpovědi tokenu AAD.
AuthenticationResult	Výsledek vrácený z koncového bodu tokenu autority. uniqueId – oid nebo sub deklarace identity z tokenu ID tenantId – tid deklarace identity z tokenu ID scopes – Obory, které jsou ověřeny pro příslušný token account – reprezentace objektu účtu aktuálně přihlášeného uživatele idToken – token ID přijatý jako součást odpovědi idTokenClaims – deklarace identity tokenů ID relevantních pro MSAL accessToken – Přístupový token nebo certifikát SSH přijatý jako součást odpovědi fromCache – logické označení, jestli token pochází z mezipaměti expiresOn – objekt Date javascriptu představující relativní vypršení platnosti přístupového tokenu extExpiresOn - JavaScript Date objekt představující rozšířený relativní vypršení platnosti přístupového tokenu v případě výpadku serveru refreshOn – objekt date javascriptu představující relativní čas, dokud se přístupový token nesmí aktualizovat state – hodnota předaná uživatelem v požadavku familyId – identifikátor ID rodiny, obvykle používaný pouze pro obnovovací tokeny requestId – ID požadavku vrácené jako součást odpovědi
AuthorizationCodePayload	Odpověď vrácená po zpracování řetězce dotazu nebo fragmentu odpovědi kódu.
AuthorizationCodeRequest	Objekt požadavku předaný uživatelem za účelem získání tokenu ze serveru výměnou platného autorizačního kódu (druhá část toku autorizačního kódu OAuth2.0) scopes – Pole oborů, ke které aplikace žádá o přístup. deklarace identity – požadavek na řetězcové deklarace identity, který se přidá do všech volání /authorize a /token autorita: – adresa URL autority, služba tokenů zabezpečení (STS), ze které služba MSAL získá tokeny. Pokud je u objektu klientské aplikace nastavená autorita, tato hodnota se přepíše. Přepsání hodnoty způsobí, že se ověření autority provede pokaždé. Pokud se pro všechny požadavky použije stejná autorita, nastavte místo požadavků objekt aplikace. correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie. redirectUri – identifikátor URI přesměrování vaší aplikace, na který se autorita přesměruje po přihlašovacích údajích a souhlasech uživatele. Musí přesně odpovídat jednomu z identifikátorů URI přesměrování, které jste zaregistrovali na portálu. tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token code – authorization_code, kterou uživatel získal v první části toku. codeVerifier – stejný code_verifier, který byl použit k získání authorization_code. Vyžaduje se, pokud se v žádosti o udělení autorizačního kódu použila infrastruktura veřejných klíčů. Další informace najdete v dokumentu PKCE RFC: https://tools.ietf.org/html/rfc7636 state – jedinečný identifikátor GUID vygenerovaný uživatelem, který je uložen v mezipaměti uživatelem a odeslán na server během první části toku. Tento řetězec je odeslán zpět serverem s autorizačním kódem. Stav uložený v mezipaměti uživatele se pak porovná se stavem přijatým ze serveru, aby se zmírnit riziko útoků CSRF. Viz https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.
AuthorizationUrlRequest	Požadavek na objekt předaný uživatelem k načtení kódu ze serveru (první část toku udělení autorizačního kódu) scopes – Pole oborů, ke které aplikace žádá o přístup. deklarace identity – požadavek na řetězcové deklarace identity, který se přidá do všech volání /authorize a /token autorita – adresa URL autority, ze které aplikace získává tokeny. correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie. redirectUri – identifikátor URI přesměrování, ve kterém může vaše aplikace přijímat odpovědi na ověřování. Musí přesně odpovídat jednomu z identifikátorů URI přesměrování registrovaných na portálu Azure. extraScopesToConsent – Obory pro jiný prostředek, pokud uživatel potřebuje souhlas předem. responseMode – Určuje metodu, která se má použít k odeslání výsledku ověřování do vaší aplikace. Může to být dotaz, form_post nebo fragment. Pokud se nepředá žádná hodnota, ve výchozím nastavení se dotazuje. codeChallenge – používá se k zabezpečení udělení autorizačního kódu prostřednictvím ověření klíče pro kód Exchange (PKCE). Další informace naleznete v PKCE RCF:https://tools.ietf.org/html/rfc7636 codeChallengeMethod – metoda použitá ke kódování ověřovatele kódu pro parametr výzvy kódu. Může to být "prostý" nebo "S256". Pokud je vyloučený, předpokládá se, že výzvou kódu je prostý text. Další informace naleznete v PKCE RCF: https://tools.ietf.org/html/rfc7636 state – hodnota zahrnutá v požadavku, který se vrátí také v odpovědi tokenu. Náhodně vygenerovaná jedinečná hodnota se obvykle používá k zabránění útokům typu útok na padělání požadavků mezi weby. Stav se také používá ke kódování informací o stavu uživatele v aplikaci před tím, než došlo k žádosti o ověření. prompt - Označuje typ interakce uživatele, který je požadován. login: vynutí, aby uživatel zadal své přihlašovací údaje na tomto požadavku a neguje jednotné přihlašování žádné: zajistí, že se uživateli nezobrazí žádná interaktivní výzva. Pokud požadavek nejde dokončit prostřednictvím jednotného přihlašování, koncový bod vrátí interaction_required souhlas s chybou: aktivuje dialogové okno souhlasu OAuth po přihlášení uživatele a požádá uživatele o udělení oprávnění k aplikaci select_account: přeruší jednotné přihlašování =při poskytování prostředí pro výběr účtu se seznamem všech účtů v relaci nebo všech zapamatových účtů nebo možnost použít jiný účet, který vytvoří: bude uživatele směrovat na prostředí pro vytváření účtu místo přihlášení. account – AccountInfo získané z rozhraní getAccount API. Pokud nejsou k dispozici parametry loginHint i sid, použije se v určitých scénářích k vygenerování login_hint. loginHint – Dá se použít k předběžnému vyplnění pole uživatelské jméno a e-mailová adresa přihlašovací stránky pro uživatele, pokud uživatelské jméno nebo e-mailovou adresu znáte předem. Aplikace tento parametr často používají při opětovném ověřování a už extrahovali uživatelské jméno z předchozího přihlášení pomocí deklarace identity preferred_username. sid – ID relace, jedinečný identifikátor relace. K dispozici jako volitelná deklarace identity u tokenů ID. domainHint – poskytuje nápovědu k tenantovi nebo doméně, kterou by měl uživatel použít k přihlášení. Hodnota nápovědy k doméně je registrovaná doména pro tenanta. extraQueryParameters – string to string map of custom query parameters added to the /authorize call tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token nonce – hodnota zahrnutá v požadavku, který je vrácen v tokenu ID. Náhodně vygenerovaná jedinečná hodnota se obvykle používá ke zmírnění útoků na přehrání.
AuthorizeResponse	Vlastnosti odpovědi, které může vrátit koncový bod /authorize
AzureCloudOptions	Konkrétní možnosti AzureCloudInstance azureCloudInstance – výčet řetězců poskytující krátký zápis pro nadlimitní a veřejné cloudové autority tenant – zřízení pro poskytnutí informací o tenantovi
BrokerOptions	Použijte tuto možnost ke konfiguraci následujících možností zprostředkovatele: nativeBrokerPlugin – nativní implementace zprostředkovatele (měla by být importována z rozšíření msal-node-extensions) Poznámka: Tyto možnosti jsou dostupné jenom pro PublicClientApplications pomocí toku autorizačního kódu.
CacheKVStore	Úložiště hodnot klíčů pro mezipaměť v paměti
CacheOptions	Tato možnost slouží ke konfiguraci následujících možností konfigurace mezipaměti: cachePlugin – Modul plug-in pro čtení a zápis mezipaměti tokenů na disk.
ClientAssertionCallback
ClientCredentialRequest	CommonClientCredentialRequest scopes – Pole oborů, ke které aplikace žádá o přístup. Obvykle obsahuje pouze výchozí obor pro jeden prostředek. Viz: https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc#the-default-scope autorita – adresa URL autority, služba tokenů zabezpečení (STS), ze které služba MSAL získá tokeny. correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie. skipCache – Přeskočte vyhledávání mezipaměti tokenů a vynuťte žádost o oprávnění k získání nového tokenu. Výchozí nastavení je „false“. clientAssertion – řetězec kontrolního výrazu nebo funkce zpětného volání, která vrací řetězec kontrolního výrazu (oba jsou podepsané JWT s kódováním Base64Url) používané v toku přihlašovacích údajů klienta tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token
Configuration	Použití objektu konfigurace ke konfiguraci knihovny MSAL a inicializaci objektu klientské aplikace Ověřování: tady konfigurujete prvky ověřování, jako je CLIENTID, autorita použitá k ověřování na platformě Microsoft Identity Platform. broker: tady konfigurujete možnosti zprostředkovatele. mezipaměť: tady konfigurujete umístění mezipaměti. systém: tady můžete nakonfigurovat síťového klienta, protokolovací nástroj. telemetrie: tady můžete konfigurovat možnosti telemetrie.
DeviceCodeRequest	Parametry toku kódu zařízení Oauth2 scopes – Pole oborů, ke které aplikace žádá o přístup. autorita: – adresa URL autority, služba tokenů zabezpečení (STS), ze které služba MSAL získá tokeny. Pokud je u objektu klientské aplikace nastavená autorita, tato hodnota se přepíše. Přepsání hodnoty způsobí, že se ověření autority provede pokaždé. Pokud se pro všechny požadavky použije stejná autorita, nastavte místo požadavků objekt aplikace. correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie. deviceCodeCallback – Zpětné volání obsahující odpověď kódu zařízení. Koncovému uživateli by se měla zobrazit zpráva. Koncový uživatel pak může přejít na verification_uri, zadat user_code a vstupní přihlašovací údaje. cancel – Logická hodnota pro zrušení dotazování koncového bodu kódu zařízení. Zatímco se uživatel ověřuje na samostatném zařízení, MSAL dotazuje koncový bod tokenu služby tokenů zabezpečení na interval zadaný v odpovědi kódu zařízení (obvykle 15 minut). Pokud chcete ukončit dotazování a zrušit požadavek, nastavte cancel=true. extraQueryParameters – string to string map of custom query parameters added to the query string
IdTokenClaims	Typ, který popisuje deklarace identity tokenu ID známé službou MSAL.
InMemoryCache	Přerušovaný typ pro zpracování datových objektů v paměti s definovanými typy
InteractiveRequest	Objekt požadavku předaný uživatelem ke konfiguraci rozhraní acquireTokenInteractive API openBrowser – Funkce pro otevření instance prohlížeče v systému uživatele. scopes – Pole oborů, ke které aplikace žádá o přístup. successTemplate: – Šablona, která se má zobrazit v otevřené instanci prohlížeče po úspěšném získání tokenu. errorTemplate – Šablona, která se má zobrazit v otevřené instanci prohlížeče při selhání získání tokenu. windowHandle – používá se v nativních tocích zprostředkovatele ke správnému nadřazení nativního okna zprostředkovatele. loopbackClient – vlastní implementace pro server zpětné smyčky pro naslouchání odpovědi autorizačního kódu.
JsonCache	Formát mezipaměti přečtený z objektu blob mezipaměti poskytnutého konfiguraci během vytváření instance aplikace
ManagedIdentityConfiguration
ManagedIdentityIdParams
ManagedIdentityRequestParams	ManagedIdentityRequest deklarace identity – žádost o řetězcové deklarace identity, která se použije k určení, jestli se má mezipaměť přeskočit, nebo ne forceRefresh – vynutí požadavky spravované identity přeskočit mezipaměť a provádět síťová volání, pokud je true prostředek – prostředek požadovaný pro přístup k chráněnému rozhraní API. Měl by být ve formátu ResourceIdUri nebo ResourceIdUri/.default. https://management.azure.net Například pro Microsoft Graph,https://graph.microsoft.com/.default
NetworkRequestOptions	Možnosti povolené rozhraními API požadavků sítě
NetworkResponse
NodeAuthOptions	clientId – ID klienta aplikace. autorita - adresa URL autority. Pokud není nastavena žádná hodnota, výchozí hodnota https://login.microsoftonline.com/commonje . knownAuthorities – potřeba pro Azure B2C a ADFS. Všechny autority, které budou použity v klientské aplikaci. Předat by měl být pouze hostitel autority. clientSecret – tajný řetězec, který aplikace používá při vyžádání tokenu. Používá se pouze v důvěrných klientských aplikacích. Lze vytvořit na portálu pro registraci aplikace Azure. clientAssertion – Objekt ClientAssertion obsahující řetězec kontrolního výrazu nebo funkci zpětného volání, která vrací řetězec kontrolního výrazu, který aplikace používá při vyžádání tokenu, a také typ kontrolního výrazu (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Používá se pouze v důvěrných klientských aplikacích. clientCertificate – certifikát, který aplikace používá při vyžádání tokenu. Používá se pouze v důvěrných klientských aplikacích. Vyžaduje šestnáctkový kryptografický otisk certifikátu X.509 SHA-1 nebo SHA-256 a privátní klíč kódovaný PEM (řetězec by měl obsahovat privátní klíč -----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY----- ). protocolMode – výčet, který představuje protokol, který následuje msal. Slouží ke konfiguraci správných koncových bodů. skipAuthorityMetadataCache – příznak, který určuje, jestli se má při inicializaci autority použít místní mezipaměť metadat nebo ne. Výchozí nastavení je „false“. encodeExtraQueryParams – příznak, který určuje, jestli se mají do adresy URL požadavku zakódovat další parametry dotazu. Výchozí nastavení je „false“.
NodeSystemOptions	Typ konfigurace možností protokolovacího nástroje a klienta HTTP logger - slouží k inicializaci objektu Logger; ÚKOL: Rozbalte podrobnosti o protokolovacím nástroji nebo odkaz na dokumentaci k protokolovacímu nástroji. networkClient – klient HTTP používaný pro všechny volání http get a post. Ve výchozím nastavení se používá výchozí klient HTTP služby MSAL.
NodeTelemetryOptions
OnBehalfOfRequest	scopes – Pole oborů, ke které aplikace žádá o přístup. autorita – adresa URL autority, služba tokenů zabezpečení (STS), ze které služba MSAL získá tokeny. correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie. oboAssertion – přístupový token, který byl odeslán do rozhraní API střední vrstvy. Tento token musí mít cílovou skupinu aplikace provádějící tuto žádost OBO. skipCache – Přeskočte vyhledávání mezipaměti tokenů a vynuťte žádost o oprávnění k získání nového tokenu. Výchozí nastavení je „false“. tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token
RefreshTokenRequest	CommonRefreshTokenRequest scopes – Pole oborů, ke které aplikace žádá o přístup. deklarace identity – požadavek na řetězcové deklarace identity, který se přidá do všech volání /authorize a /token autorita – adresa URL autority, služba tokenů zabezpečení (STS), ze které služba MSAL získá tokeny. correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie. refreshToken – obnovovací token vrácený z předchozího požadavku zprostředkovatele identity. tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token forceCache – Vynutit MSAL ukládání odpovědi na tok obnovovacího tokenu do mezipaměti, pokud v mezipaměti neexistuje žádný účet. Používá se pro scénáře migrace.
SerializedAccessTokenEntity	Typ přihlašovacích údajů přístupového tokenu
SerializedAccountEntity	Typ účtu
SerializedAppMetadataEntity	Typ AppMetadata
SerializedIdTokenEntity	Typ přihlašovacích údajů Idtoken
SerializedRefreshTokenEntity	Typ přihlašovacích údajů obnovovacího tokenu
SignOutRequest
SilentFlowRequest	Parametry SilentFlow předávané uživatelem za účelem tichého načtení přihlašovacích údajů scopes – Pole oborů, ke které aplikace žádá o přístup. deklarace identity – požadavek na řetězcové deklarace identity, který se přidá do všech volání /authorize a /token. Pokud je součástí tichého požadavku, vyhledávání mezipaměti se přeskočí a token se aktualizuje. autorita – adresa URL autority, ze které aplikace získává tokeny. correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie. tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token account – Entita účtu pro vyhledání přihlašovacích údajů. forceRefresh – Vynutí tiché požadavky na volání sítě, pokud je true.
UsernamePasswordRequest	Parametry UsernamePassword předané uživatelem k načtení přihlašovacích údajů Poznámka: Nejnovější osvědčený postup zabezpečení OAuth 2.0 v současné době zakáže udělení hesla zcela. Tento tok se přidá pro interní testování. scopes – Pole oborů, ke které aplikace žádá o přístup. deklarace identity – požadavek na řetězcové deklarace identity, který se přidá do všech volání /authorize a /token. Pokud je součástí tichého požadavku, vyhledávání mezipaměti se přeskočí a token se aktualizuje. autorita – adresa URL autority, ze které aplikace získává tokeny. correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie. uživatelské jméno – uživatelské jméno klienta heslo – přihlašovací údaje tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token

Výčty

LogLevel

Úroveň zprávy protokolu

Proměnné

AzureCloudInstance
ManagedIdentitySourceNames	Názvy zdrojů spravovaných identit
ProtocolMode	Režimy protokolu podporované knihovnou MSAL.
ResponseMode	povolené hodnoty pro response_mode
AuthErrorMessage	AuthErrorMessage třída obsahující řetězcové konstanty používané kódy chyb a zprávy.
ClientAuthErrorMessage	Řetězcové konstanty používané kódy chyb a zprávami
ClientConfigurationErrorMessage	ClientConfigurationErrorMessage třída obsahující řetězcové konstanty používané kódy chyb a zprávy.
InteractionRequiredAuthErrorMessage	Interakce požadovaných chyb definovaných sadou SDK
PromptValue	Místo řetězce jsme tento výčet v požadavku považovali za vytvoření výčtu, ale vypadá to, že povolený seznam hodnot výzvy se během posledních několika let neustále mění. U některých interních partnerů existují i některé nezdokumentované hodnoty výzvy, proto je místo výčtu zvolená obecná hodnota typu string.
version

Podrobnosti proměnné

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

Typ

{ 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

Názvy zdrojů spravovaných identit

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

Typ

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

ProtocolMode

Režimy protokolu podporované knihovnou MSAL.

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

Typ

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

ResponseMode

povolené hodnoty pro response_mode

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

Typ

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

AuthErrorMessage

Upozornění

Toto rozhraní API je teď zastaralé.

Use AuthErrorCodes instead

AuthErrorMessage třída obsahující řetězcové konstanty používané kódy chyb a zprávy.

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

Typ

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

ClientAuthErrorMessage

Upozornění

Toto rozhraní API je teď zastaralé.

Use ClientAuthErrorCodes instead

Řetězcové konstanty používané kódy chyb a zprávami

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

Typ

{ 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

Upozornění

Toto rozhraní API je teď zastaralé.

Use ClientConfigurationErrorCodes instead

ClientConfigurationErrorMessage třída obsahující řetězcové konstanty používané kódy chyb a zprávy.

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

Typ

{ 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

Upozornění

Toto rozhraní API je teď zastaralé.

Use InteractionRequiredAuthErrorCodes instead

Interakce požadovaných chyb definovaných sadou SDK

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

Typ

{ 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

Místo řetězce jsme tento výčet v požadavku považovali za vytvoření výčtu, ale vypadá to, že povolený seznam hodnot výzvy se během posledních několika let neustále mění. U některých interních partnerů existují i některé nezdokumentované hodnoty výzvy, proto je místo výčtu zvolená obecná hodnota typu string.

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

Typ

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

version

version: "3.8.10"

Typ

"3.8.10"