@azure/msal-common package

Obecná třída chyby vyvolaná knihovnou MSAL.js

Toto je pomocná třída, která analyzuje podporované hlavičky ověřování odpovědi HTTP za účelem extrakce a vrácení hodnot výzvy hlaviček, které je možné použít mimo základní autorizační toky.

Chyba vyvolaná v případě chyby s mezipamětí

Chyba vyvolaná v případě, že v kódu klienta spuštěném v prohlížeči došlo k chybě.

Při konfiguraci knihovny MSAL.js došlo k chybě.

Při vyžadování interakce uživatele došlo k chybě.

Třída, která usnadňuje protokolování zpráv na určité místo.

Představuje chyby související se sítí.

Třída chyby modulu runtime MSAL, která zachovává podrobné informace o zprostředkovateli

Třída, která poskytuje pomocné rutiny pro hodnoty specifické pro protokol OAuth 2.0

Třída ScopeSet vytvoří sadu oborů. Obory nerozlišují malá a velká písmena, jedinečné hodnoty, takže Objekt Set v JS dává největší smysl implementovat pro tuto třídu. Všechny obory se oříznou a převedou na malé řetězce v průsečíku a sjednocovací funkce, aby se zajistila jedinečnost řetězců.

Chyba vyvolaná v případě, že dojde k chybě s kódem serveru, například nedostupnost.

Třída objektu URL, která může provádět různé transformace řetězců adresy URL.

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.

Rozhraní pro kryptografické funkce používané knihovnou

Klientské síťové rozhraní pro odesílání požadavků back-endu

Rozhraní, které popisuje komponenty identifikátoru URI.

Typ mezipaměti přístupového tokenu

Účet: <home_account_id-environment-realm><><*>

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

Typ mezipaměti metadat aplikace

Telemetrické informace odeslané na žádost

• appName: Jedinečný název řetězce aplikace
• appVersion: Verze aplikace používající knihovnu MSAL

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

Odpověď vrácená po zpracování řetězce dotazu nebo fragmentu odpovědi kódu.

Vlastnosti odpovědi, které může vrátit koncový bod /authorize

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

BaseAuthRequest

• autorita – adresa URL autority, služba tokenů zabezpečení (STS), ze které služba MSAL získá tokeny. Výchozí hodnota je https://login.microsoftonline.com/common. Pokud pro všechny žádosti používáte stejnou autoritu, měla by se autorita nastavit u objektu klientské aplikace a neměla by vyžadovat, aby se zabránilo vícenásobnému překladu koncových bodů autority.
• correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie.
• scopes – Pole oborů, ke které aplikace žádá o přístup.
• authenticationScheme – typ načteného tokenu. Výchozí hodnota je "Bearer". Můžete také zadat "pop" nebo "SSH".
• deklarace identity – požadavek na řetězcové deklarace identity, který se přidá do všech volání /authorize a /token
• shrClaims – objekt stringifikovaných deklarací identity, který se přidá do podepsaného požadavku HTTP
• shrNonce – časové razítko generované serverem, které bylo zašifrováno a kódováno base64URL, které se přidá do podepsaného požadavku HTTP.
• shrOptions – objekt obsahující možnosti pro podepsaný požadavek HTTP
• resourceRequestMethod – typ požadavku HTTP použitý k vyžádání dat z prostředku (tj. GET, POST atd.). Používá se pro toky proti vlastnictví.
• resourceRequestUri – identifikátor URI, pro který se token použije. Používá se pro toky proti vlastnictví.
• sshJwk – řetězecifikovaný webový klíč JSON představující veřejný klíč, který je možné podepsat certifikátem SSH.
• sshKid – ID klíče, které jednoznačně identifikuje veřejný klíč SSH uvedený výše.
• azureCloudOptions – výčty řetězců pohodlí pro uživatele, kteří mají poskytovat ID veřejného nebo suverénního cloudu
• requestedClaimsHash – hashový řetězec SHA 256 požadovaného řetězce deklarací identity, který se používá jako součást klíče mezipaměti přístupového tokenu, aby se tokeny mohly filtrovat podle požadovaných deklarací identity
• tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token
• tokenBodyParameters - String to string map of custom parameters added to the body of the /token call
• storeInCache – Objekt obsahující logické hodnoty označující, jestli se mají ukládat tokeny v mezipaměti nebo ne (výchozí hodnota je true)
• scenarioId – ID scénáře pro sledování vlastních výzev uživatelů
• popKid – ID klíče k identifikaci veřejného klíče pro žádost o token PoP
• embeddedClientId – Vložené ID klienta. Po zadání se id klienta zprostředkovatele (brk_client_id) a parametry identifikátoru URI přesměrování (brk_redirect_uri) nastaví s hodnotami z konfigurace, přičemž v případě přítomnosti přepíše odpovídající parametry navíc.
• httpMethod – metoda HTTP, která se má použít pro požadavek /authorize. Výchozí nastavení GET, ale pokud požadavek vyžaduje základní parametry, můžete ho nastavit na POST.
• authorizePostBodyParameters - String to string map of custom parameters added to the body of the /authorize call when httpMethod is set to POST
• skipBrokerClaims - Pokud je použit true a zprostředkovaný tok (například když jsou přítomny parametry zprostředkovatele nebo embeddedClientId), klientCapabilities z konfigurace budou vyloučeny z deklarací identity; ignorováno pro nezprostředkované toky.

Slouží ke konfiguraci předvoleb mezipaměti přihlašovacích údajů v objektu ClientConfiguration.

• claimsBasedCachingEnabled – Nastaví, jestli se mají tokeny ukládat do mezipaměti na základě hodnoty hash deklarací identity. Výchozí hodnota je nastavená na false.

Objekt informace o klientovi, který se skládá z: uid: id uživatele utid: ID tenanta xms_tdbr: volitelné, pouze pro tenanty mimo USA

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.
• 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
• resourceRequestMethod – typ požadavku HTTP použitý k vyžádání dat z prostředku (tj. GET, POST atd.). Používá se pro toky proti vlastnictví.
• resourceRequestUri – identifikátor URI, pro který se token použije. Používá se pro toky proti vlastnictví.
• enableSpaAuthCode – Povolí aqusition autorizačního kódu wellness (pouze důvěrné klienty).
• tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token

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 do prostředí pro vytváření účtu místo přihlašovacího prostředí no_session: při ověřování uživatele nebude číst existující token relace. Po úspěšném ověření uživatele EVO pro uživatele nevytvoří novou relaci. POUZE PRO INTERNÍ POUŽITÍ.
• 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í.
• resourceRequestMethod – typ požadavku HTTP použitý k vyžádání dat z prostředku (tj. GET, POST atd.). Používá se pro toky proti vlastnictví.
• resourceRequestUri – identifikátor URI, pro který se token použije. Používá se pro toky proti vlastnictví.

CommonEndSessionRequest

• account – Objekt účtu, ze kterého bude odhlášený. Všechny tokeny vázané na tento účet budou vymazány.
• postLogoutRedirectUri – identifikátor URI pro přechod na stránku odhlášení.
• correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie.
• idTokenHint – token ID používaný B2C k ověření odhlášení v případě potřeby zásadou
• state – hodnota zahrnutá v požadavku do koncového bodu odhlášení, který se vrátí v řetězci dotazu při přesměrování po odhlášení.
• logoutHint – řetězec, který určuje účet, který se odhlašuje, aby se při odhlášení přeskočí výběr účtu serveru.
• extraQueryParameters – string to string map of custom query parameters added to the /authorize call

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.
• resourceRequestMethod – typ požadavku HTTP použitý k vyžádání dat z prostředku (tj. GET, POST atd.). Používá se pro toky proti vlastnictví.
• resourceRequestUri – identifikátor URI, pro který se token použije. Používá se pro toky proti vlastnictví.
• 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.
• tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token

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.
• account – Entita účtu pro vyhledání přihlašovacích údajů.
• forceRefresh – Vynutí tiché požadavky na volání sítě, pokud je true.
• resourceRequestMethod – typ požadavku HTTP použitý k vyžádání dat z prostředku (tj. GET, POST atd.). Používá se pro toky proti vlastnictví.
• resourceRequestUri – identifikátor URI, pro který se token použije. Používá se pro toky proti vlastnictví.
• tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token

Typ mezipaměti přihlašovacích údajů

Přihlašovací údaje: <home_account_id*>-<environment-credential_type-client_id-realm<><><>*>-<target*>-<scheme*>

Objekt odpovědi používaný k načítání externích tokenů do mezipaměti.

• token_type: Označuje hodnotu typu tokenu. Jediným typem, který Azure AD podporuje, je Bearer.
• scope: Obory, pro které je access_token platné.
• expires_in: Jak dlouho je přístupový token platný (v sekundách).
• id_token: Webový token JSON (JWT). Aplikace může dekódovat segmenty tohoto tokenu a požádat o informace o uživateli, který se přihlásil.
• refresh_token: Obnovovací token OAuth 2.0. Aplikace může tento token použít k získání dalších přístupových tokenů po vypršení platnosti aktuálního přístupového tokenu.
• access_token: Požadovaný přístupový token. Aplikace může tento token použít k ověření zabezpečeného prostředku, jako je webové rozhraní API.
• client_info: Objekt informace o klientovi

Typ mezipaměti tokenu ID

Typ, který definuje objekt, který je řetězcově zakódován a odeslán ve stavové hodnotě. Obsahuje následující položky:

• ID – jedinečný identifikátor pro tento požadavek
• ts – časové razítko pro čas provedení požadavku. Používá se k zajištění nesprávného výpočtu vypršení platnosti tokenu.
• platformState – řetězcová hodnota odeslaná z platformy.

To slouží ke konfiguraci protokolování, které služba MSAL provede, konfigurací možností protokolovacího nástroje v objektu Konfigurace.

• loggerCallback – zpětné volání pro protokolovací službu
• piiLoggingEnabled – Nastaví, jestli je povolené protokolování pii.
• logLevel – nastaví úroveň, na které se protokolování provede.
• correlationId – nastaví ID korelace vytištěné protokolovacím nástrojem.

Možnosti povolené rozhraními API požadavků sítě

Možnosti pro režim protokolu OIDC.

Měření výkonu prováděné knihovnou, včetně metadat o požadavku a aplikaci.

Typ PkceCodes popisuje strukturu objektů, které obsahují výzvu kódu PKCE a dvojice ověřovatelů.

Typ měření fronty

Typ mezipaměti obnovovacího tokenu

Zadejte, který definuje řetězecifikovaný a kódovaný objekt odeslaný službě v autorizaci požadavku.

Typ představující jedinečný kryptografický otisk požadavku

Deserializovaný objekt odpovědi z požadavku na autorizační kód serveru

• token_type: Označuje hodnotu typu tokenu. Může to být nosný nebo pop.
• scope: Obory, pro které je access_token platné.
• expires_in: Jak dlouho je přístupový token platný (v sekundách).
• refresh_in: Doba trvání odvozování tokenu bez ohledu na vypršení platnosti.
• ext_expires_in: Jak dlouho je přístupový token platný (v sekundách), pokud server nereaguje.
• access_token: Požadovaný přístupový token. Aplikace může tento token použít k ověření zabezpečeného prostředku, jako je webové rozhraní API.
• refresh_token: Obnovovací token OAuth 2.0. Aplikace může tento token použít k získání dalších přístupových tokenů po vypršení platnosti aktuálního přístupového tokenu.
• id_token: Webový token JSON (JWT). Aplikace může dekódovat segmenty tohoto tokenu a požádat o informace o uživateli, který se přihlásil.
• key_id: Řetězec, který jednoznačně identifikuje veřejný klíč, ke kterému je požadavek vázán.

V případě chyby:

• chyba: Řetězec kódu chyby, který lze použít ke klasifikaci typů chyb, ke kterým dochází, a lze jej použít k reakci na chyby.
• error_description: Konkrétní chybová zpráva, která může vývojáři pomoct identifikovat původní příčinu chyby ověřování.
• error_codes: Seznam kódů chyb specifických pro stS, které můžou pomoct s diagnostikou.
• časové razítko: Čas, kdy došlo k chybě.
• trace_id: Jedinečný identifikátor požadavku, který může pomoct s diagnostikou.
• correlation_id: Jedinečný identifikátor požadavku, který může pomoct s diagnostikou napříč komponentami.
• stav: stav odpovědi na požadavek sítě

Určuje, jestli mají být tokeny uložené v mezipaměti, nebo ne. Pokud je nastavená hodnota false, tokeny mohou být stále získány a vráceny, ale nebudou uloženy do mezipaměti pro pozdější načtení.

typ Key-Value pro podporu queryParams, extraQueryParams a deklarací identity

Tato možnost slouží ke konfiguraci informací o prodloužení platnosti tokenu v objektu Konfigurace.

• tokenRenewalOffsetSeconds – nastaví interval posunu potřebný k prodloužení platnosti tokenu před vypršením platnosti.

Podrobnosti o účtu, které se u stejného uživatele liší v různých tenantech

Typ, který popisuje deklarace identity tokenu ID známé službou MSAL.

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

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.

Přihlašovací údaje klientského kontrolního výrazu pro důvěrné klienty

CommonClientCredentialRequest

• 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.
• 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“.
• preferredAzureRegionOptions – možnosti upřednostňované oblasti Azure uživatele
• tokenQueryParameters – řetězec k řetězcové mapě vlastních parametrů dotazu přidaných do volání /token

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.
• resourceRequestMethod – typ požadavku HTTP použitý k vyžádání dat z prostředku (tj. GET, POST atd.). Používá se pro toky proti vlastnictví.
• resourceRequestUri – identifikátor URI, pro který se token použije. Používá se pro toky proti vlastnictví.
• časový limit – doba časového limitu v sekundách, během které uživatel explicitně nakonfiguruje dotazování koncového bodu kódu zařízení. Na konci tohoto období; za předpokladu, že kód zařízení ještě nevypršel; Dotazování kódu zařízení se zastaví a žádost se zruší. Okno vypršení platnosti kódu zařízení bude mít vždy přednost před tímto nastaveným obdobím.
• extraQueryParameters – string to string map of custom query parameters added to the query string

• 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

CommonUsernamePassword parametry předané uživatelem pro načtení přihlašovacích údajů Poznámka: Nejnovější osvědčený postup zabezpečení OAuth 2.0 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

DeviceCode vrácený koncovým bodem kódu zařízení služby tokenů zabezpečení obsahující informace nezbytné pro tok kódu zařízení.

• userCode: kód, který uživatel musí zadat při ověřování na ověřovacím identifikátoru URI
• deviceCode: kód, který by měl být součástí požadavku na přístupový token
• verificationUri: identifikátor URI, kde se uživatel může ověřit
• expirsIn: doba vypršení platnosti kódu zařízení v sekundách
• interval: interval, ve kterém se má služba STS dotazovat
• message: message which should be displayed to the user

Úroveň zprávy protokolu

Stav události výkonu

Výčet operací, které jsou instrumentované pomocí jejich výkonu měřeno PerformanceClient.

Funkce pro sestavení objektu informací o klientovi z řetězce clientInfo serveru

Funkce pro sestavení objektu informací klienta z řetězce homeAccountId uloženého v mezipaměti

Vytvoření profilu tenanta

Pomocná funkce zalamování chyb prohlížeče v objektu CacheError

Vytvoří chybu InteractionRequiredAuthError.

Vytvoří objekt NetworkError pro neúspěšný síťový požadavek.

Získá id tenanta z dostupných deklarací identity tokenu ID, které se nastaví jako sféra přihlašovacích údajů s následující prioritou:

1. tid – pokud je token získán z tenanta Azure AD tid bude k dispozici.
2. tfp – pokud je token získán z moderního tenanta B2C tfp by měl být k dispozici
3. acr – pokud se token získá ze starší verze tenanta B2C acr, měl by se zobrazit downcas, aby odpovídal požadavkům na porovnání velkých a malých písmen.

Vrátí hodnotu true, pokud id tenanta odpovídá části utid homeAccountId.

Nahradí informace o účtu, které se liší podle profilu tenanta zdrojového z deklarací identity tokenů ID předaných informacemi o účtu specifickém pro tenanta.

Řetězcové konstanty související s autoritou AAD

Typ žádosti o ověření

Typy autorit podporované knihovnou MSAL.

Typy účtů v mezipaměti

Určuje důvod načtení přístupového tokenu od zprostředkovatele identity.

Kombinování všech typů mezipaměti

Klíče žádostí o deklarace identity

Typ přihlašovacích údajů uložený v mezipaměti

povolené grant_type

Názvy hlaviček požadavků

Povolené hodnoty pro response_type

Parametry udělení hesla

Trvalé klíče mezipaměti MSAL, které zůstávají, když je uživatel přihlášený.

Režimy protokolu podporované knihovnou MSAL.

povolené hodnoty pro response_mode

povolené hodnoty pro typ odpovědi serveru

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

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

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

povolené hodnoty pro codeVerifier

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

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.

Konstanty související s omezováním