@azure/msal-node package
Klasy
| AuthError |
Ogólna klasa błędów zgłaszana przez bibliotekę MSAL.js. |
| ClientApplication |
Podstawowa klasa abstrakcyjna dla wszystkich aplikacji ClientApplications — publiczna i poufne |
| ClientAssertion |
Asercja klienta typu jwt-bearer używana w poufnych przepływach klienta |
| 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. |
| ClientCredentialClient |
Udzielanie poświadczeń klienta OAuth2.0 |
| ConfidentialClientApplication |
Ta klasa służy do uzyskiwania tokenów dla poufnych aplikacji klienckich (webApp, webAPI). Poufne aplikacje klienckie będą konfigurować wpisy tajne aplikacji, certyfikaty/aseracje klienta zgodnie z obowiązującymi |
| CryptoProvider |
Ta klasa implementuje interfejs kryptograficzny węzła MSAL, który umożliwia mu wykonywanie kodowania i dekodowania base64, generowanie kryptograficznie losowych identyfikatorów GUID i implementowanie klucza dowodowego dla kodu Exchange specyfikacji przepływu kodu autoryzacji OAuth przy użyciu PKCE (rfc tutaj: https://tools.ietf.org/html/rfc7636). |
| DeviceCodeClient |
Klient kodu urządzenia OAuth2.0 |
| DistributedCachePlugin |
Wtyczka pamięci podręcznej, która serializuje dane do pamięci podręcznej i deserializuje dane z pamięci podręcznej |
| InteractionRequiredAuthError |
Błąd zgłaszany, gdy wymagana jest interakcja użytkownika. |
| Logger |
Klasa, która ułatwia rejestrowanie komunikatów w określonym miejscu. |
| ManagedIdentityApplication |
Klasa inicjowania tożsamości zarządzanej i identyfikowania usługi |
| OnBehalfOfClient |
KlientBehalf-Of |
| PublicClientApplication |
Ta klasa ma służyć do uzyskiwania tokenów dla publicznych aplikacji klienckich (komputery, urządzenia przenośne). Publiczne aplikacje klienckie nie są zaufane do bezpiecznego przechowywania wpisów tajnych aplikacji i dlatego mogą żądać tylko tokenów w nazwie użytkownika. |
| ServerError |
Błąd zgłaszany w przypadku wystąpienia błędu z kodem serwera, na przykład niedostępności. |
| TokenCache |
Menedżer pamięci podręcznej tokenów w pamięci |
| 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 |
| UsernamePasswordClient |
Oauth2.0 Klient udzielania haseł Uwaga: obsługujemy tylko klientów publicznych na potrzeby udzielania haseł i wyłącznie do celów testowych |
Interfejsy
| IAppTokenProvider | |
| ICacheClient |
Interfejs pamięci podręcznej definiującej element pobierający i ustawiający |
| ICachePlugin | |
| IConfidentialClientApplication |
Interfejs klasy ConfidentialClientApplication definiujący publiczne sygnatury interfejsu API |
| ILoopbackClient |
Interfejs dla elementu LoopbackClient umożliwiający zastąpienie domyślnego serwera sprzężenia zwrotnego niestandardową implementacją. |
| INativeBrokerPlugin | |
| INetworkModule |
Interfejs sieciowy klienta do wysyłania żądań zaplecza. |
| IPartitionManager |
Interfejs definiujący metody pobierania umożliwiające uzyskanie kluczy używanych do obsługi danych tożsamości w pamięci podręcznej |
| IPublicClientApplication |
Interfejs klasy PublicClientApplication definiujący publiczne sygnatury interfejsu API |
| ISerializableTokenCache | |
| ITokenCache |
Interfejs pamięci podręcznej tokenu dla klienta, dając dostęp do interfejsów API pamięci podręcznej |
Aliasy typu
| AccountInfo |
Obiekt konta z następującym podpisem:
|
| AppTokenProviderParameters |
Obiekt wejściowy dla rozszerzalności IAppTokenProvider. Biblioteka MSAL utworzy ten obiekt, który może służyć do tworzenia obiektu AppTokenProviderResult.
|
| AppTokenProviderResult |
Obiekt wyjściowy dla rozszerzenia IAppTokenProvider.
|
| AuthenticationResult |
Wynik zwrócony z punktu końcowego tokenu urzędu.
|
| AuthorizationCodePayload |
Odpowiedź zwrócona po przetworzeniu ciągu zapytania lub fragmentu odpowiedzi kodu. |
| AuthorizationCodeRequest |
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)
|
| AuthorizationUrlRequest |
Zażądaj obiektu przekazanego przez użytkownika w celu pobrania kodu z serwera (pierwszy etap przepływu udzielania kodu autoryzacji)
|
| AuthorizeResponse |
Właściwości odpowiedzi, które mogą być zwracane przez punkt końcowy /authorize |
| AzureCloudOptions |
Opcje specyficzne dla usługi AzureCloudInstance
|
| BrokerOptions |
Użyj tej opcji, aby skonfigurować poniższe opcje brokera:
Uwaga: Te opcje są dostępne tylko dla elementu PublicClientApplications przy użyciu przepływu kodu autoryzacji |
| CacheKVStore |
Magazyn wartości klucza dla pamięci podręcznej w pamięci |
| CacheOptions |
Użyj tej opcji, aby skonfigurować poniższe opcje konfiguracji pamięci podręcznej:
|
| ClientAssertionCallback | |
| ClientCredentialRequest |
CommonClientCredentialRequest
|
| Configuration |
Używanie obiektu konfiguracji do konfigurowania biblioteki MSAL i inicjowania obiektu aplikacji klienckiej
|
| DeviceCodeRequest |
Parametry przepływu kodu urządzenia Oauth2.
|
| IdTokenClaims |
Typ opisujący oświadczenia tokenu identyfikatora znane przez bibliotekę MSAL. |
| InMemoryCache |
Sporadyczne typy do obsługi obiektów danych w pamięci ze zdefiniowanymi typami |
| InteractiveRequest |
Żądanie obiektu przekazanego przez użytkownika w celu skonfigurowania interfejsu API acquireTokenInteractive
|
| JsonCache |
Format pamięci podręcznej odczytywany z obiektu blob pamięci podręcznej udostępniany do konfiguracji podczas tworzenia wystąpienia aplikacji |
| ManagedIdentityConfiguration | |
| ManagedIdentityIdParams | |
| ManagedIdentityRequestParams |
ManagedIdentityRequest
|
| NetworkRequestOptions |
Opcje dozwolone przez interfejsy API żądań sieciowych. |
| NetworkResponse | |
| NodeAuthOptions |
|
| NodeSystemOptions |
Typ konfigurowania rejestratora i opcji klienta http
|
| NodeTelemetryOptions | |
| OnBehalfOfRequest |
|
| RefreshTokenRequest |
CommonRefreshTokenRequest
|
| SerializedAccessTokenEntity |
Typ poświadczeń tokenu dostępu |
| SerializedAccountEntity |
Typ konta |
| SerializedAppMetadataEntity |
Typ AppMetadata |
| SerializedIdTokenEntity |
Typ poświadczeń idtoken |
| SerializedRefreshTokenEntity |
Odśwież typ poświadczeń tokenu |
| SignOutRequest | |
| SilentFlowRequest |
Parametry SilentFlow przekazane przez użytkownika w celu dyskretnego pobierania poświadczeń
|
| UsernamePasswordRequest |
Parametry UsernamePassword 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.
|
Wyliczenia
| LogLevel |
Poziom komunikatu dziennika. |
Zmienne
| Azure |
|
| Managed |
Nazwy źródeł tożsamości zarządzanej |
| Protocol |
Tryby protokołu obsługiwane przez bibliotekę MSAL. |
| Response |
dozwolone wartości dla response_mode |
| Auth |
AuthErrorMessage, klasa zawierająca stałe ciągów używane przez kody błędów i komunikaty. |
| Client |
Stałe ciągów używane przez kody błędów i komunikaty. |
| Client |
ClientConfigurationErrorMessage, klasa zawierająca stałe ciągów używane przez kody błędów i komunikaty. |
| Interaction |
Wymagane błędy interakcji zdefiniowane przez zestaw SDK |
| Prompt |
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" |
| version |
Szczegóły zmiennej
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
Nazwy źródeł tożsamości zarządzanej
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
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" }
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 } }
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 } }
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 }
version
version: "3.8.10"Typ
"3.8.10"