@azure/msal-common package

Klasy

AuthError	Ogólna klasa błędów zgłaszana przez bibliotekę MSAL.js.
AuthenticationHeaderParser	Jest to klasa pomocnika, która analizuje obsługiwane nagłówki uwierzytelniania odpowiedzi HTTP w celu wyodrębniania i zwracania wartości wyzwania nagłówka, które mogą być używane poza podstawowymi przepływami autoryzacji.
CacheError	Błąd zgłaszany w przypadku wystąpienia błędu z pamięcią podręczną
ClientAuthError	Błąd zgłaszany w przypadku wystąpienia błędu w kodzie klienta uruchomionym w przeglądarce.
ClientConfigurationError	Błąd zgłaszany w przypadku wystąpienia błędu w konfiguracji biblioteki MSAL.js.
InteractionRequiredAuthError	Błąd zgłaszany, gdy wymagana jest interakcja użytkownika.
Logger	Klasa, która ułatwia rejestrowanie komunikatów w określonym miejscu.
NetworkError	Reprezentuje błędy związane z siecią
PerformanceClient
PlatformBrokerError	Klasa błędów błędów błędów dotyczących błędów środowiska uruchomieniowego MSAL, które zachowują szczegółowe informacje o brokerze
ProtocolUtils	Klasa, która udostępnia pomocników dla wartości specyficznych dla protokołu OAuth 2.0
ScopeSet	Klasa ScopeSet tworzy zestaw zakresów. Zakresy są bez uwzględniania wielkości liter, unikatowe wartości, więc obiekt Set w języku JS ma największe znaczenie do zaimplementowania dla tej klasy. Wszystkie zakresy są przycinane i konwertowane na ciągi małych liter w funkcjach przecięcia i unii w celu zapewnienia unikatowości ciągów.
ServerError	Błąd zgłaszany w przypadku wystąpienia błędu z kodem serwera, na przykład niedostępności.
StubPerformanceClient
UrlString	Klasa obiektów url, która może wykonywać różne przekształcenia w ciągach adresu URL.
TokenCacheContext	To wystąpienie klasy ułatwia śledzenie zmian pamięci ułatwiających podejmowanie decyzji dotyczących odczytu i zapisu w trwałej pamięci podręcznej

Interfejsy

ICrypto	Interfejs funkcji kryptograficznych używanych przez bibliotekę
ILoggerCallback
INetworkModule	Interfejs sieciowy klienta do wysyłania żądań zaplecza.
IPerformanceClient
IPerformanceMeasurement
IUri	Interfejs opisujący składniki identyfikatora URI.
PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

Aliasy typu

AccessTokenEntity	Typ pamięci podręcznej tokenu dostępu
AccountFilter	Konto: <home_account_id-obszar-obszar<>><*>
AccountInfo	Obiekt konta z następującym podpisem: homeAccountId — identyfikator konta głównego dla tego obiektu konta environment — jednostka, która wystawiła token reprezentowany przez domenę wystawcy (np. login.microsoftonline.com) tenantId — pełny identyfikator dzierżawy lub organizacji, do którego należy to konto nazwa użytkownika — preferred_username oświadczenie id_token, które reprezentuje to konto localAccountId — lokalne, specyficzne dla dzierżawy identyfikatory konta dla tego obiektu konta, zwykle używane w starszych przypadkach name — pełna nazwa konta, w tym imię i nazwisko idToken — nieprzetworzony token identyfikatora idTokenClaims — obiekt zawiera oświadczenia z tokenu identyfikatora nativeAccountId — identyfikator konta natywnego użytkownika tenantProfiles — mapa obiektów profilu dzierżawy dla każdej dzierżawy, za pomocą którego konto zostało uwierzytelnione w przeglądarce dataBoundary — granica danych wyodrębniona z elementu clientInfo
ActiveAccountFilters
AppMetadataEntity	Typ pamięci podręcznej metadanych aplikacji
ApplicationTelemetry	Informacje telemetryczne wysyłane na żądanie appName: unikatowa nazwa ciągu aplikacji appVersion: wersja aplikacji przy użyciu biblioteki MSAL
AuthenticationResult	Wynik zwrócony z punktu końcowego tokenu urzędu. uniqueId — oid lub sub oświadczenie z tokenu identyfikatora tenantId — tid oświadczenie z tokenu identyfikatora scopes — zakresy, które są weryfikowane dla odpowiedniego tokenu account — reprezentacja obiektu konta aktualnie zalogowanego użytkownika idToken — token identyfikatora odebrany w ramach odpowiedzi idTokenClaims — oświadczenia tokenu identyfikatora odpowiedniego biblioteki MSAL accessToken — token dostępu lub certyfikat SSH odebrany w ramach odpowiedzi fromCache — wartość logiczna określająca, czy token pochodzi z pamięci podręcznej expiresOn — obiekt daty javascript reprezentujący względne wygaśnięcie tokenu dostępu extExpiresOn — obiekt daty javascript reprezentujący przedłużony względny wygaśnięcie tokenu dostępu w przypadku awarii serwera refreshOn — obiekt daty javascript reprezentujący czas względny do czasu odświeżenia tokenu dostępu state — wartość przekazana przez użytkownika w żądaniu familyId — identyfikator rodziny, zwykle używany tylko do odświeżania tokenów requestId — identyfikator żądania zwrócony w ramach odpowiedzi
AuthorityOptions
AuthorizationCodePayload	Odpowiedź zwrócona po przetworzeniu ciągu zapytania lub fragmentu odpowiedzi kodu.
AuthorizeResponse	Właściwości odpowiedzi, które mogą być zwracane przez punkt końcowy /authorize
AzureCloudOptions	Opcje specyficzne dla usługi AzureCloudInstance azureCloudInstance — wyliczenie ciągu zapewniające krótką notację dla urzędów chmury publicznej i trybu soverign tenant — aprowizacja w celu udostępnienia informacji o dzierżawie
AzureRegion
AzureRegionConfiguration
BaseAuthRequest	BaseAuthRequest authority — adres URL urzędu, usługa tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny. Wartość domyślna to https://login.microsoftonline.com/common. Jeśli używasz tego samego urzędu dla wszystkich żądań, urząd powinien ustawić dla obiektu aplikacji klienckiej, a nie żądać, aby uniknąć wielokrotnego rozpoznawania punktów końcowych urzędu. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. scopes — tablica zakresów, do których aplikacja żąda dostępu. authenticationScheme — typ pobranego tokenu. Wartość domyślna to "Bearer". Można również wpisać "pop" lub "SSH". claims — żądanie oświadczeń ciągyfikowanych, które zostanie dodane do wszystkich /authorize i /token wywołań shrClaims — obiekt oświadczeń ciągyfikowanych, który zostanie dodany do podpisanego żądania HTTP shrNonce — sygnatura czasowa wygenerowana przez serwer, która została zaszyfrowana i zakodowana w formacie base64URL, która zostanie dodana do podpisanego żądania HTTP. shrOptions — obiekt zawierający opcje podpisanego żądania HTTP resourceRequestMethod — typ żądania HTTP używany do żądania danych z zasobu (np. "GET", "POST" itp.). Służy do przepływu dowodu posiadania. resourceRequestUri — identyfikator URI, dla którego będzie używany token. Służy do przepływu dowodu posiadania. sshJwk — ciągyfikowany klucz internetowy JSON reprezentujący klucz publiczny, który może być podpisany przez certyfikat SSH. sshKid — identyfikator klucza, który jednoznacznie identyfikuje klucz publiczny SSH wymieniony powyżej. azureCloudOptions — wyliczenie ciągów wygody dla użytkowników w celu udostępnienia identyfikatorów chmury publicznej/suwerennej requestedClaimsHash — ciąg skrótu SHA 256 żądanego ciągu oświadczeń, używany jako część klucza pamięci podręcznej tokenu dostępu, dzięki czemu tokeny mogą być filtrowane według żądanych oświadczeń tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token tokenBodyParameters — ciąg do ciągu mapy parametrów niestandardowych dodanych do treści wywołania /token storeInCache — obiekt zawierający wartości logiczne wskazujące, czy mają być przechowywane tokeny w pamięci podręcznej, czy nie (wartość domyślna to prawda) scenarioId — identyfikator scenariusza do śledzenia niestandardowych monitów użytkownika popKid — identyfikator klucza identyfikujący klucz publiczny dla żądania tokenu poP embeddedClientId — identyfikator klienta osadzonego. Po określeniu parametrów identyfikator klienta brokera (brk_client_id) i identyfikator przekierowania (brk_redirect_uri) są ustawiane z wartościami z konfiguracji, przesłaniając odpowiednie dodatkowe parametry, jeśli istnieją. httpMethod — metoda HTTP do użycia dla żądania /authorize. Wartość domyślna to GET, ale można ustawić wartość POST, jeśli żądanie wymaga parametrów treści authorizePostBodyParameters — ciąg do ciągu mapy parametrów niestandardowych dodanych do treści wywołania /authorize, gdy parametr httpMethod jest ustawiony na POST skipBrokerClaims — jeśli jest używana wartość true i przepływ obsługiwany przez brokera (na przykład w przypadku wystąpienia parametrów brokera lub osadzonego identyfikatoraClientId), wartość clientCapabilities z konfiguracji zostanie wykluczona z oświadczeń; ignorowane dla przepływów bez brokera.
CacheOptions	Służy do konfigurowania preferencji pamięci podręcznej poświadczeń w obiekcie ClientConfiguration claimsBasedCachingEnabled — określa, czy tokeny powinny być buforowane na podstawie skrótu oświadczeń. Wartość domyślna to „false”.
CcsCredential
ClientInfo	Obiekt informacji o kliencie, który składa się z: uid: identyfikator użytkownika utid: identyfikator dzierżawy xms_tdbr: opcjonalne, tylko dla dzierżaw innych niż USA
CommonAuthorizationCodeRequest	Zażądaj obiektu przekazanego przez użytkownika w celu uzyskania tokenu z serwera wymieniającego prawidłowy kod autoryzacji (drugi etap przepływu kodu autoryzacji OAuth2.0) scopes — tablica zakresów, do których aplikacja żąda dostępu. claims — żądanie oświadczeń ciągyfikowanych, które zostanie dodane do wszystkich /authorize i /token wywołań authority: — adres URL urzędu, usługa tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny. Jeśli urząd jest ustawiony dla obiektu aplikacji klienckiej, spowoduje to zastąpienie tej wartości. Zastąpienie wartości spowoduje, że walidacja urzędu będzie miała miejsce za każdym razem. Jeśli ten sam urząd będzie używany dla wszystkich żądań, ustaw dla obiektu aplikacji zamiast żądań. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. redirectUri — identyfikator URI przekierowania aplikacji, do którego urząd przekierowuje po wprowadzeniu poświadczeń i zgody użytkownika. Musi dokładnie odpowiadać jednemu z identyfikatorów URI przekierowania zarejestrowanych w portalu code — authorization_code, które użytkownik nabył w pierwszym etapie przepływu. codeVerifier — ten sam code_verifier, który został użyty do uzyskania authorization_code. Wymagane, jeśli klucz PKCE został użyty w żądaniu udzielenia kodu autoryzacji. Aby uzyskać więcej informacji, zobacz PKCE RFC: https://tools.ietf.org/html/rfc7636 resourceRequestMethod — typ żądania HTTP używany do żądania danych z zasobu (np. "GET", "POST" itp.). Służy do przepływu dowodu posiadania. resourceRequestUri — identyfikator URI, dla którego będzie używany token. Służy do przepływu dowodu posiadania. enableSpaAuthCode — włącza aqusition kodu autoryzacji spa (tylko klienci poufne) tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token
CommonAuthorizationUrlRequest	Zażądaj obiektu przekazanego przez użytkownika w celu pobrania kodu z serwera (pierwszy etap przepływu udzielania kodu autoryzacji) scopes — tablica zakresów, do których aplikacja żąda dostępu. claims — żądanie oświadczeń ciągyfikowanych, które zostanie dodane do wszystkich /authorize i /token wywołań authority — adres URL urzędu, z którego aplikacja uzyskuje tokeny. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. redirectUri — identyfikator URI przekierowania, w którym można odbierać odpowiedzi uwierzytelniania przez aplikację. Musi dokładnie odpowiadać jednemu z identyfikatorów URI przekierowania zarejestrowanych w portalu Azure. extraScopesToConsent — zakresy dla innego zasobu, gdy użytkownik potrzebuje zgody z góry. responseMode — określa metodę, która ma być używana do wysyłania wyniku uwierzytelniania do aplikacji. Może to być zapytanie, form_post lub fragment. Jeśli żadna wartość nie zostanie przekazana, wartość domyślna to zapytanie. codeChallenge — służy do zabezpieczania udzielania kodu autoryzacji za pośrednictwem klucza weryfikacji kodu Exchange (PKCE). Aby uzyskać więcej informacji, zobacz PKCE RCF:https://tools.ietf.org/html/rfc7636 codeChallengeMethod — metoda używana do kodowania weryfikatora kodu dla parametru wyzwania kodu. Może to być "zwykły" lub "S256". W przypadku wykluczenia wyzwanie kodu przyjmuje się jako zwykły tekst. Aby uzyskać więcej informacji, zobacz PKCE RCF: https://tools.ietf.org/html/rfc7636 state — wartość uwzględniona w żądaniu, który jest również zwracany w odpowiedzi tokenu. Losowo wygenerowana unikatowa wartość jest zwykle używana do zapobiegania atakom fałszerzowanym żądań między witrynami. Stan jest również używany do kodowania informacji o stanie użytkownika w aplikacji przed wystąpieniem żądania uwierzytelnienia. prompt — wskazuje wymagany typ interakcji użytkownika. login: wymusi na użytkowniku wprowadzenie poświadczeń na tym żądaniu, negując brak logowania jednokrotnego: upewni się, że użytkownik nie jest wyświetlany z żadnym interakcyjnym monitem. Jeśli nie można ukończyć żądania za pomocą logowania jednokrotnego, punkt końcowy zwróci interaction_required zgodę na błąd: czy wyzwalacz okno dialogowe zgody OAuth po zalogowaniu się użytkownika z prośbą użytkownika o udzielenie uprawnień do aplikacji select_account: spowoduje przerwanie logowania jednokrotnego=na potrzeby udostępniania środowiska wyboru konta zawierającego listę wszystkich kont w sesji lub wszystkich zapamiętanych kont lub opcję użycia innego konta: spowoduje przekierowanie użytkownika do środowiska tworzenia konta zamiast środowiska logowania no_session: nie odczytuje istniejącego tokenu sesji podczas uwierzytelniania użytkownika. Po pomyślnym uwierzytelnieniu użytkownika EVO nie utworzy nowej sesji dla użytkownika. TYLKO DO UŻYTKU WEWNĘTRZNEGO. account — informacje o koncie uzyskane z interfejsu API getAccount. Będzie używany w niektórych scenariuszach do generowania login_hint, jeśli nie podano parametrów loginHint i sid. loginHint — może służyć do wstępnego wypełnienia pola nazwy użytkownika/adresu e-mail strony logowania użytkownika, jeśli znasz wcześniej nazwę użytkownika/adres e-mail. Często aplikacje używają tego parametru podczas ponownego uwierzytelniania, po wyodrębnieniu nazwy użytkownika z poprzedniego logowania przy użyciu oświadczenia preferred_username. sid — identyfikator sesji, unikatowy identyfikator sesji. Dostępne jako opcjonalne oświadczenie dotyczące tokenów identyfikatorów. domainHint — zawiera wskazówkę dotyczącą dzierżawy lub domeny, za pomocą którego użytkownik powinien się zalogować. Wartość wskazówki dotyczącej domeny jest zarejestrowaną domeną dla dzierżawy. extraQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /authorize tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token nonce — wartość uwzględniona w żądaniu zwróconym w tokenie identyfikatora. Losowo wygenerowana unikatowa wartość jest zwykle używana do łagodzenia ataków powtarzania. resourceRequestMethod — typ żądania HTTP używany do żądania danych z zasobu (np. "GET", "POST" itp.). Służy do przepływu dowodu posiadania. resourceRequestUri — identyfikator URI, dla którego będzie używany token. Służy do przepływu dowodu posiadania.
CommonEndSessionRequest	CommonEndSessionRequest account — obiekt konta, który zostanie wylogowany. Wszystkie tokeny powiązane z tym kontem zostaną wyczyszczone. postLogoutRedirectUri — identyfikator URI, aby przejść do strony po wylogowaniu. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. idTokenHint — token identyfikatora używany przez usługę B2C do sprawdzania poprawności wylogowywanie, jeśli jest to wymagane przez zasady state — wartość uwzględniona w żądaniu do punktu końcowego wylogowania, który zostanie zwrócony w ciągu zapytania po wylogowaniu przekierowania logoutHint — ciąg określający konto, które jest wylogowywane w celu pominięcia selektora kont serwera podczas wylogowywanie extraQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /authorize
CommonRefreshTokenRequest	CommonRefreshTokenRequest scopes — tablica zakresów, do których aplikacja żąda dostępu. claims — żądanie oświadczeń ciągyfikowanych, które zostanie dodane do wszystkich /authorize i /token wywołań authority — adres URL urzędu, usługa tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. refreshToken — token odświeżania zwrócony z poprzedniego żądania do dostawcy tożsamości. resourceRequestMethod — typ żądania HTTP używany do żądania danych z zasobu (np. "GET", "POST" itp.). Służy do przepływu dowodu posiadania. resourceRequestUri — identyfikator URI, dla którego będzie używany token. Służy do przepływu dowodu posiadania. forceCache — wymusza buforowanie odpowiedzi przepływu tokenu odświeżania przez bibliotekę MSAL w przypadku braku konta w pamięci podręcznej. Służy do obsługi scenariuszy migracji. tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token
CommonSilentFlowRequest	Parametry SilentFlow przekazane przez użytkownika w celu dyskretnego pobierania poświadczeń scopes — tablica zakresów, do których aplikacja żąda dostępu. claims — żądanie oświadczeń ciągowych, które zostanie dodane do wszystkich wywołań /authorize i /token. Po dołączeniu do żądania dyskretnego wyszukiwanie pamięci podręcznej zostanie pominięte, a token zostanie odświeżony. authority — adres URL urzędu, z którego aplikacja uzyskuje tokeny. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. account — jednostka konta do wyszukiwania poświadczeń. forceRefresh — wymusza dyskretne żądania, aby wykonywać wywołania sieciowe, jeśli jest to prawda. resourceRequestMethod — typ żądania HTTP używany do żądania danych z zasobu (np. "GET", "POST" itp.). Służy do przepływu dowodu posiadania. resourceRequestUri — identyfikator URI, dla którego będzie używany token. Służy do przepływu dowodu posiadania. tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token
CredentialEntity	Typ pamięci podręcznej poświadczeń
CredentialFilter	Poświadczenie: <home_account_id*>-<environment-credential_type-client_id-realm>><><*-<<target*>>-<scheme*>
ExternalTokenResponse	Obiekt odpowiedzi używany do ładowania tokenów zewnętrznych do pamięci podręcznej. token_type: wskazuje wartość typu tokenu. Jedynym typem, który obsługuje Azure AD, jest bearer. zakres: zakresy, dla których access_token są prawidłowe. expires_in: jak długo token dostępu jest prawidłowy (w sekundach). id_token: token internetowy JSON (JWT). Aplikacja może dekodować segmenty tego tokenu, aby zażądać informacji o użytkowniku, który się zalogował. refresh_token: token odświeżania OAuth 2.0. Aplikacja może użyć tego tokenu, aby uzyskać dodatkowe tokeny dostępu po wygaśnięciu bieżącego tokenu dostępu. access_token: żądany token dostępu. Aplikacja może używać tego tokenu do uwierzytelniania w zabezpieczonym zasobie, takim jak internetowy interfejs API. client_info: obiekt informacji o kliencie
IdTokenEntity	Typ pamięci podręcznej tokenu identyfikatora
InProgressPerformanceEvent
LibraryStateObject	Typ, który definiuje obiekt, który jest ciągyfikowany, zakodowany i wysyłany w wartości stanu. Zawiera następujące elementy: id — unikatowy identyfikator dla tego żądania ts — sygnatura czasowa czasu żądania. Służy do zapewnienia, że wygaśnięcie tokenu nie jest obliczane niepoprawnie. platformState — wartość ciągu wysłana z platformy.
LoggerOptions	Użyj tego polecenia, aby skonfigurować rejestrowanie, które wykonuje biblioteka MSAL, konfigurując opcje rejestratora w obiekcie Configuration loggerCallback — wywołanie zwrotne dla rejestratora piiLoggingEnabled — określa, czy rejestrowanie pii jest włączone logLevel — ustawia poziom, na którym odbywa się rejestrowanie correlationId — ustawia identyfikator correlationId wydrukowany przez rejestrator
NetworkRequestOptions	Opcje dozwolone przez interfejsy API żądań sieciowych.
NetworkResponse
OIDCOptions	Opcje trybu protokołu OIDC.
PerformanceCallbackFunction
PerformanceEvent	Pomiar wydajności wykonywany przez bibliotekę, w tym metadane dotyczące żądania i aplikacji.
PkceCodes	Typ PkceCodes opisuje strukturę obiektów zawierających wyzwanie kodu PKCE i pary weryfikatora
QueueMeasurement	Typ miary kolejki
RefreshTokenEntity	Odśwież typ pamięci podręcznej tokenu
RequestStateObject	Typ, który definiuje ciągyfikowany i zakodowany obiekt wysyłany do usługi w żądaniu autoryzacji.
RequestThumbprint	Typ reprezentujący unikatowy odcisk palca żądania.
ServerAuthorizationTokenResponse	Deserializowany obiekt odpowiedzi z żądania kodu autoryzacji serwera. token_type: wskazuje wartość typu tokenu. Może to być element nośny lub pop. zakres: zakresy, dla których access_token są prawidłowe. expires_in: jak długo token dostępu jest prawidłowy (w sekundach). refresh_in: czas trwania odroczenia, który token powinien zostać odnowiony, niezależnie od wygaśnięcia. ext_expires_in: jak długo token dostępu jest prawidłowy (w sekundach), jeśli serwer nie odpowiada. access_token: żądany token dostępu. Aplikacja może używać tego tokenu do uwierzytelniania w zabezpieczonym zasobie, takim jak internetowy interfejs API. refresh_token: token odświeżania OAuth 2.0. Aplikacja może użyć tego tokenu, aby uzyskać dodatkowe tokeny dostępu po wygaśnięciu bieżącego tokenu dostępu. id_token: token internetowy JSON (JWT). Aplikacja może dekodować segmenty tego tokenu, aby zażądać informacji o użytkowniku, który się zalogował. key_id: ciąg, który jednoznacznie identyfikuje klucz publiczny powiązany z żądaniem. W przypadku błędu: błąd: Ciąg kodu błędu, który może służyć do klasyfikowania typów błędów występujących i może służyć do reagowania na błędy. error_description: określony komunikat o błędzie, który może pomóc deweloperowi zidentyfikować główną przyczynę błędu uwierzytelniania. error_codes: lista kodów błędów specyficznych dla usługi STS, które mogą pomóc w diagnostyce. sygnatura czasowa: czas wystąpienia błędu. trace_id: unikatowy identyfikator żądania, który może pomóc w diagnostyce. correlation_id: unikatowy identyfikator żądania, który może pomóc w diagnostyce między składnikami. status: stan odpowiedzi żądania sieciowego
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache	Określa, czy tokeny powinny być przechowywane w pamięci podręcznej, czy nie. Jeśli ustawiono wartość false, tokeny mogą być nadal uzyskiwane i zwracane, ale nie będą buforowane do późniejszego pobierania.
StringDict	Key-Value typ do obsługi zapytańParams, extraQueryParams i oświadczeń
SubMeasurement
SystemOptions	Służy do konfigurowania informacji o odnawianiu tokenu w obiekcie Konfiguracji tokenRenewalOffsetSeconds — ustawia okno przesunięcia potrzebne do odnowienia tokenu przed wygaśnięciem
TenantProfile	Szczegóły konta, które różnią się w różnych dzierżawach dla tego samego użytkownika
ThrottlingEntity
TokenClaims	Typ opisujący oświadczenia tokenu identyfikatora znane przez bibliotekę MSAL.
TokenKeys
AppTokenProviderParameters	Obiekt wejściowy dla rozszerzalności IAppTokenProvider. Biblioteka MSAL utworzy ten obiekt, który może służyć do tworzenia obiektu AppTokenProviderResult. correlationId — identyfikator korelacji skojarzony z żądaniem tenantId — identyfikator dzierżawy, dla którego należy podać token scopes — zakresy, dla których należy podać token oświadczenia — wszelkie dodatkowe oświadczenia, które token musi spełniać
AppTokenProviderResult	Obiekt wyjściowy dla rozszerzenia IAppTokenProvider. accessToken — rzeczywisty token dostępu, zwykle w formacie JWT, który spełnia wymagania dotyczące danych żądania AppTokenProviderParameters expiresInSeconds — czas wygaśnięcia tokenów przed wygaśnięciem w sekundach. Podobnie jak w polu "expires_in" w odpowiedzi tokenu usługi AAD. refreshInSeconds — jak długo token ma być aktywnie odświeżany. Podobnie jak w polu "refresh_in" w odpowiedzi tokenu usługi AAD.
ClientAssertion	Poświadczenia potwierdzenia klienta dla klientów poufnych
ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest	CommonClientCredentialRequest scopes — tablica zakresów, do których aplikacja żąda dostępu. authority — adres URL urzędu, usługa tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. skipCache — pomiń wyszukiwanie pamięci podręcznej tokenu i wymusza żądanie do urzędu w celu uzyskania nowego tokenu. Wartość domyślna to fałsz. preferredAzureRegionOptions — opcje preferowanego regionu platformy Azure użytkownika tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token
CommonDeviceCodeRequest	Parametry przepływu kodu urządzenia Oauth2. scopes — tablica zakresów, do których aplikacja żąda dostępu. authority: — adres URL urzędu, usługa tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny. Jeśli urząd jest ustawiony dla obiektu aplikacji klienckiej, spowoduje to zastąpienie tej wartości. Zastąpienie wartości spowoduje, że walidacja urzędu będzie miała miejsce za każdym razem. Jeśli ten sam urząd będzie używany dla wszystkich żądań, ustaw dla obiektu aplikacji zamiast żądań. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. deviceCodeCallback — wywołanie zwrotne zawierające odpowiedź kodu urządzenia. Komunikat powinien być wyświetlany użytkownikowi końcowemu. Użytkownik końcowy może następnie przejść do verification_uri, wprowadzić user_code i poświadczenia wejściowe. cancel — wartość logiczna, aby anulować sondowanie punktu końcowego kodu urządzenia. Podczas uwierzytelniania użytkownika na oddzielnym urządzeniu biblioteka MSAL sonduje punkt końcowy tokenu usługi tokenu zabezpieczającego dla interwału określonego w odpowiedzi kodu urządzenia (zwykle 15 minut). Aby zatrzymać sondowanie i anulować żądanie, ustaw wartość cancel=true. resourceRequestMethod — typ żądania HTTP używany do żądania danych z zasobu (np. "GET", "POST" itp.). Służy do przepływu dowodu posiadania. resourceRequestUri — identyfikator URI, dla którego będzie używany token. Służy do przepływu dowodu posiadania. limit czasu — limit czasu w sekundach, w których użytkownik jawnie konfiguruje sondowanie punktu końcowego kodu urządzenia. Na koniec tego okresu; przy założeniu, że kod urządzenia nie wygasł jeszcze; sondowanie kodu urządzenia zostało zatrzymane i żądanie zostało anulowane. Okno wygasania kodu urządzenia zawsze będzie mieć pierwszeństwo przed tym ustawionym okresem. extraQueryParameters — ciąg do mapy ciągów niestandardowych parametrów zapytania dodanych do ciągu zapytania
CommonOnBehalfOfRequest	scopes — tablica zakresów, do których aplikacja żąda dostępu. authority — adres URL urzędu, usługa tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. oboAssertion — token dostępu, który został wysłany do interfejsu API warstwy środkowej. Ten token musi mieć odbiorców aplikacji wysyłającej to żądanie OBO. skipCache — pomiń wyszukiwanie pamięci podręcznej tokenu i wymusza żądanie do urzędu w celu uzyskania nowego tokenu. Wartość domyślna to fałsz. tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token
CommonUsernamePasswordRequest	Parametry CommonUsernamePassword przekazane przez użytkownika w celu pobrania poświadczeń Uwaga: Najnowsze najlepsze rozwiązania zabezpieczeń protokołu OAuth 2.0 nie zezwalają na całkowite przyznanie hasła. Ten przepływ jest dodawany do testów wewnętrznych. scopes — tablica zakresów, do których aplikacja żąda dostępu. claims — żądanie oświadczeń ciągowych, które zostanie dodane do wszystkich wywołań /authorize i /token. Po dołączeniu do żądania dyskretnego wyszukiwanie pamięci podręcznej zostanie pominięte, a token zostanie odświeżony. authority — adres URL urzędu, z którego aplikacja uzyskuje tokeny. correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii. nazwa użytkownika — nazwa użytkownika klienta hasło — poświadczenia tokenQueryParameters — ciąg do ciągu mapy niestandardowych parametrów zapytania dodanych do wywołania /token
DeviceCodeResponse	Kod urządzenia zwrócony przez punkt końcowy kodu urządzenia usługi tokenu zabezpieczającego zawierający informacje niezbędne do przepływu kodu urządzenia. userCode: kod, który użytkownik musi podać podczas uwierzytelniania przy użyciu identyfikatora URI weryfikacji deviceCode: kod, który powinien zostać uwzględniony w żądaniu tokenu dostępu verificationUri: identyfikator URI, w którym użytkownik może się uwierzytelnić expirationsIn: czas wygaśnięcia kodu urządzenia w sekundach interwał: interwał, w którym usługa STS powinna być sondowana w komunikat: komunikat, który powinien być wyświetlany użytkownikowi
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

Wyliczenia

LogLevel	Poziom komunikatu dziennika.
PerformanceEventStatus	Stan zdarzenia wydajności.
PerformanceEvents	Wyliczenie operacji, które są instrumentowane przez ich wydajność mierzoną przez klienta PerformanceClient.

Funkcje

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)
buildClientInfo(string, (input: string) => string)	Funkcja do kompilowania obiektu informacji o kliencie z ciągu clientInfo serwera
buildClientInfoFromHomeAccountId(string)	Funkcja tworzenia obiektu informacji o kliencie z buforowanego ciągu homeAccountId
buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)	Tworzenie profilu dzierżawy
createAuthError(string, string)
createCacheError(unknown)	Funkcja pomocnika do zawijania błędów przeglądarki w obiekcie CacheError
createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)	Tworzy element InteractionRequiredAuthError
createNetworkError(AuthError, number, Record<string, string>, Error)	Tworzy obiekt NetworkError dla nieudanego żądania sieciowego
formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)	Pobiera identyfikator tenantId z dostępnych oświadczeń tokenu identyfikatora, aby ustawić jako obszar poświadczeń z następującym pierwszeństwem: tid — jeśli token zostanie uzyskany z dzierżawy usługi Azure AD, będzie obecny tfp — jeśli token jest uzyskiwany z nowoczesnej dzierżawy B2C tfp powinien być obecny acr — jeśli token jest uzyskiwany ze starszej dzierżawy B2C, powinien być obecny w usłudze Downcased, aby był zgodny z wymaganiami porównania bez uwzględniania wielkości liter
tenantIdMatchesHomeTenant(string, string)	Zwraca wartość true, jeśli identyfikator tenantId pasuje do części utid identyfikatora homeAccountId
updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)	Zastępuje informacje o koncie, które różnią się w zależności od profilu dzierżawy pochodzącego z oświadczeń tokenu identyfikatora przekazanych za pomocą informacji o koncie specyficznym dla dzierżawy

Zmienne

AADAuthorityConstants	Stałe ciągów związane z urzędem usługi AAD
AuthenticationScheme	Typ żądania uwierzytelniania
AuthorityType	Typy urzędu obsługiwane przez bibliotekę MSAL.
AzureCloudInstance
CacheAccountType	Typy kont w pamięci podręcznej
CacheOutcome	Określa przyczynę pobierania tokenu dostępu od dostawcy tożsamości
CacheType	Łączenie wszystkich typów pamięci podręcznej
CcsCredentialType
ClaimsRequestKeys	Żądania oświadczeń kluczy
CredentialType	Typ poświadczeń przechowywany w pamięci podręcznej
EncodingTypes
GrantType	dozwolone grant_type
HeaderNames	Nazwy nagłówków żądań
HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType	Dozwolone wartości dla response_type
PasswordGrantConstants	Parametry udzielania haseł
PersistentCacheKeys	Trwałe klucze pamięci podręcznej MSAL, które pozostają podczas logowania użytkownika.
ProtocolMode	Tryby protokołu obsługiwane przez bibliotekę MSAL.
ResponseMode	dozwolone wartości dla response_mode
ServerResponseType	dozwolone wartości dla typu odpowiedzi serwera
AuthErrorMessage	AuthErrorMessage, klasa zawierająca stałe ciągów używane przez kody błędów i komunikaty.
ClientAuthErrorMessage	Stałe ciągów używane przez kody błędów i komunikaty.
ClientConfigurationErrorMessage	ClientConfigurationErrorMessage, klasa zawierająca stałe ciągów używane przez kody błędów i komunikaty.
CodeChallengeMethodValues	dozwolone wartości dla elementu codeVerifier
Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage	Wymagane błędy interakcji zdefiniowane przez zestaw SDK
OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue	Rozważaliśmy wprowadzenie tego "wyliczenia" w żądaniu zamiast ciągu, jednak wygląda na to, że lista dozwolonych wartości monitów zmieniała się w ciągu ostatnich kilku lat. Istnieje kilka nieudokumentowanych wartości monitów dla niektórych partnerów wewnętrznych, dlatego wybór ogólnego typu "ciąg" zamiast "wyliczenia"
StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants	Stałe związane z ograniczaniem przepustowości
version

Szczegóły funkcji

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

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

Parametry

cacheStorage

CacheManager

authority

Authority

homeAccountId

string

base64Decode

(input: string) => string

correlationId

string

idTokenClaims

TokenClaims

clientInfo

string

environment

string

claimsTenantId

null | string

authCodePayload

AuthorizationCodePayload

nativeAccountId

string

logger

Logger

Zwraca

AccountEntity

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

Funkcja do kompilowania obiektu informacji o kliencie z ciągu clientInfo serwera

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

Parametry

rawClientInfo

string

base64Decode

(input: string) => string

Zwraca

ClientInfo

buildClientInfoFromHomeAccountId(string)

Funkcja tworzenia obiektu informacji o kliencie z buforowanego ciągu homeAccountId

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Parametry

homeAccountId

string

Zwraca

ClientInfo

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

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

Parametry

authOptions

Partial<AuthorityOptions>

Zwraca

StaticAuthorityOptions

buildTenantProfile(string, string, string, TokenClaims)

Tworzenie profilu dzierżawy

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

Parametry

homeAccountId

string

Identyfikator konta głównego dla tego obiektu konta

localAccountId

string

Identyfikator konta lokalnego dla tego obiektu konta

tenantId

string

Pełny identyfikator dzierżawy lub organizacji, do którego należy to konto

idTokenClaims

TokenClaims

Oświadczenia z tokenu identyfikatora

Zwraca

TenantProfile

createAuthError(string, string)

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

Parametry

code

string

additionalMessage

string

Zwraca

AuthError

createCacheError(unknown)

Funkcja pomocnika do zawijania błędów przeglądarki w obiekcie CacheError

function createCacheError(e: unknown): CacheError

Parametry

e

unknown

Zwraca

CacheError

createClientAuthError(string, string)

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

Parametry

errorCode

string

additionalMessage

string

Zwraca

ClientAuthError

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Parametry

errorCode

string

Zwraca

ClientConfigurationError

createInteractionRequiredAuthError(string)

Tworzy element InteractionRequiredAuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Parametry

errorCode

string

Zwraca

InteractionRequiredAuthError

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

Tworzy obiekt NetworkError dla nieudanego żądania sieciowego

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

Parametry

error

AuthError

Błąd, który ma zostać zwrócony do elementu wywołującego

httpStatus

number

Kod stanu żądania sieciowego

responseHeaders

Record<string, string>

Nagłówki odpowiedzi żądania sieciowego, jeśli są dostępne

additionalError

Error

Zwraca

NetworkError

NetworkError, obiekt

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Parametry

authorityUri

string

Zwraca

string

getRequestThumbprint(string, BaseAuthRequest, string)

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

Parametry

clientId

string

request

BaseAuthRequest

homeAccountId

string

Zwraca

RequestThumbprint

getTenantIdFromIdTokenClaims(TokenClaims)

Pobiera identyfikator tenantId z dostępnych oświadczeń tokenu identyfikatora, aby ustawić jako obszar poświadczeń z następującym pierwszeństwem:

1. tid — jeśli token zostanie uzyskany z dzierżawy usługi Azure AD, będzie obecny
2. tfp — jeśli token jest uzyskiwany z nowoczesnej dzierżawy B2C tfp powinien być obecny
3. acr — jeśli token jest uzyskiwany ze starszej dzierżawy B2C, powinien być obecny w usłudze Downcased, aby był zgodny z wymaganiami porównania bez uwzględniania wielkości liter

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

Parametry

idTokenClaims

TokenClaims

Zwraca

string | null

tenantIdMatchesHomeTenant(string, string)

Zwraca wartość true, jeśli identyfikator tenantId pasuje do części utid identyfikatora homeAccountId

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

Parametry

tenantId

string

homeAccountId

string

Zwraca

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Zastępuje informacje o koncie, które różnią się w zależności od profilu dzierżawy pochodzącego z oświadczeń tokenu identyfikatora przekazanych za pomocą informacji o koncie specyficznym dla dzierżawy

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

Parametry

baseAccountInfo

AccountInfo

tenantProfile

TenantProfile

idTokenClaims

TokenClaims

idTokenSecret

string

Zwraca

AccountInfo

Szczegóły zmiennej

AADAuthorityConstants

Stałe ciągów związane z urzędem usługi AAD

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

Typ

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

AuthenticationScheme

Typ żądania uwierzytelniania

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

Typ

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

AuthorityType

Typy urzędu obsługiwane przez bibliotekę MSAL.

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

Typ

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

AzureCloudInstance

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

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

CacheAccountType

Typy kont w pamięci podręcznej

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

Typ

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

CacheOutcome

Określa przyczynę pobierania tokenu dostępu od dostawcy tożsamości

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

Typ

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

CacheType

Łączenie wszystkich typów pamięci podręcznej

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

Typ

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

CcsCredentialType

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

Typ

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

ClaimsRequestKeys

Żądania oświadczeń kluczy

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

Typ

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

CredentialType

Typ poświadczeń przechowywany w pamięci podręcznej

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

Typ

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

EncodingTypes

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

Typ

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

GrantType

dozwolone grant_type

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

Typ

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

HeaderNames

Nazwy nagłówków żądań

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

Typ

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

HttpMethod

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

Typ

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

HttpStatus

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

Typ

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

JsonWebTokenTypes

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

Typ

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

OAuthResponseType

Dozwolone wartości dla response_type

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

Typ

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

PasswordGrantConstants

Parametry udzielania haseł

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

Typ

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

PersistentCacheKeys

Trwałe klucze pamięci podręcznej MSAL, które pozostają podczas logowania użytkownika.

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

Typ

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

ProtocolMode

Tryby protokołu obsługiwane przez bibliotekę MSAL.

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

Typ

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

ResponseMode

dozwolone wartości dla response_mode

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

Typ

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

ServerResponseType

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use ResponseMode instead

dozwolone wartości dla typu odpowiedzi serwera

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

Typ

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

AuthErrorMessage

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use AuthErrorCodes instead

AuthErrorMessage, klasa zawierająca stałe ciągów używane przez kody błędów i komunikaty.

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

Typ

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

ClientAuthErrorMessage

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use ClientAuthErrorCodes instead

Stałe ciągów używane przez kody błędów i komunikaty.

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

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use ClientConfigurationErrorCodes instead

ClientConfigurationErrorMessage, klasa zawierająca stałe ciągów używane przez kody błędów i komunikaty.

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

CodeChallengeMethodValues

dozwolone wartości dla elementu codeVerifier

CodeChallengeMethodValues: { PLAIN: string, S256: string }

Typ

{ PLAIN: string, S256: string }

Constants

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

Typ

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

DEFAULT_CRYPTO_IMPLEMENTATION

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

Typ

ICrypto

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Typ

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

Typ

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

Typ

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

Typ

ReadonlySet<string>

InteractionRequiredAuthErrorMessage

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use InteractionRequiredAuthErrorCodes instead

Wymagane błędy interakcji zdefiniowane przez zestaw 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 } }

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

Typ

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

Typ

86400000

PromptValue

Rozważaliśmy wprowadzenie tego "wyliczenia" w żądaniu zamiast ciągu, jednak wygląda na to, że lista dozwolonych wartości monitów zmieniała się w ciągu ostatnich kilku lat. Istnieje kilka nieudokumentowanych wartości monitów dla niektórych partnerów wewnętrznych, dlatego wybór ogólnego typu "ciąg" zamiast "wyliczenia"

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 }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

Typ

INetworkModule

THE_FAMILY_ID

THE_FAMILY_ID: "1"

Typ

"1"

ThrottlingConstants

Stałe związane z ograniczaniem przepustowości

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

Typ

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

version

version: "15.17.0"

Typ

"15.17.0"