@azure/msal-node package
Классы
| AuthError |
Общий класс ошибок, вызванный библиотекой MSAL.js. |
| ClientApplication |
Базовый абстрактный класс для всех ClientApplications — общедоступный и конфиденциальный |
| ClientAssertion |
Утверждение клиента типа jwt-носителя, используемого в конфиденциальных потоках клиента |
| ClientAuthError |
Возникает ошибка при возникновении ошибки в клиентском коде, работающем в браузере. |
| ClientConfigurationError |
Возникает ошибка при возникновении ошибки в конфигурации библиотеки MSAL.js. |
| ClientCredentialClient |
Предоставление учетных данных клиента OAuth2.0 |
| ConfidentialClientApplication |
Этот класс используется для получения маркеров для конфиденциальных клиентских приложений (webApp, webAPI). Конфиденциальные клиентские приложения будут настраивать секреты приложений, сертификаты и утверждения клиента в соответствии с применимыми |
| CryptoProvider |
Этот класс реализует криптографический интерфейс узла MSAL, который позволяет выполнять кодировку и декодирование base64, создавая криптографически случайные идентификаторы GUID и реализуя спецификации проверки подлинности для кода Exchange спецификации потока кода авторизации OAuth с помощью PKCE (rfc здесь: https://tools.ietf.org/html/rfc7636). |
| DeviceCodeClient |
Клиент кода устройства OAuth2.0 |
| DistributedCachePlugin |
Подключаемый модуль кэша, который сериализует данные в кэш и десериализирует данные из кэша. |
| InteractionRequiredAuthError |
Ошибка, возникаемая при необходимости взаимодействия с пользователем. |
| Logger |
Класс, который упрощает ведение журнала сообщений в определенном месте. |
| ManagedIdentityApplication |
Класс для инициализации управляемого удостоверения и идентификации службы |
| OnBehalfOfClient |
КлиентBehalf-Of |
| PublicClientApplication |
Этот класс используется для получения маркеров для общедоступных клиентских приложений (классических, мобильных устройств). Общедоступные клиентские приложения не являются доверенными для безопасного хранения секретов приложений и поэтому могут запрашивать только маркеры в имени пользователя. |
| ServerError |
Возникает ошибка при возникновении ошибки с кодом сервера, например недоступности. |
| TokenCache |
Диспетчер кэша маркеров в памяти |
| TokenCacheContext |
Этот экземпляр класса помогает отслеживать изменения памяти, упрощающие чтение и запись в постоянный кэш. |
| UsernamePasswordClient |
Примечание клиента о предоставлении пароля Oauth2.0: мы поддерживаем только общедоступные клиенты для предоставления пароля и исключительно для тестирования |
Интерфейсы
| IAppTokenProvider | |
| ICacheClient |
Интерфейс для кэша, определяющий метод получения и задания |
| ICachePlugin | |
| IConfidentialClientApplication |
Интерфейс для класса ConfidentialClientApplication, определяющего подписи общедоступного API |
| ILoopbackClient |
Интерфейс для LoopbackClient, позволяющий заменить сервер обратного цикла по умолчанию на пользовательскую реализацию. |
| INativeBrokerPlugin | |
| INetworkModule |
Клиентский сетевой интерфейс для отправки внутренних запросов. |
| IPartitionManager |
Интерфейс, определяющий методы получения ключей, используемых для идентификации данных в кэше |
| IPublicClientApplication |
Интерфейс для класса PublicClientApplication, определяющего подписи общедоступного API |
| ISerializableTokenCache | |
| ITokenCache |
Интерфейс кэша маркеров для клиента, предоставляющий доступ к API кэша |
Псевдонимы типа
| AccountInfo |
Объект учетной записи со следующей подписью:
|
| AppTokenProviderParameters |
Входной объект для расширяемости IAppTokenProvider. MSAL создаст этот объект, который можно использовать для создания AppTokenProviderResult.
|
| AppTokenProviderResult |
Выходной объект для расширяемости IAppTokenProvider.
|
| AuthenticationResult |
Результат, возвращенный из конечной точки маркера центра.
|
| AuthorizationCodePayload |
Ответ возвращается после обработки строки запроса ответа кода или фрагмента. |
| AuthorizationCodeRequest |
Запрос объекта, передаваемого пользователем, для получения маркера с сервера, обменивающегося допустимым кодом авторизации (второй этап потока кода авторизации OAuth2.0)
|
| AuthorizationUrlRequest |
Запрос объекта, передаваемого пользователем, для получения кода с сервера (первый этап потока предоставления кода авторизации)
|
| AuthorizeResponse |
Свойства ответа, которые могут быть возвращены конечной точкой /authorize |
| AzureCloudOptions |
Конкретные параметры AzureCloudInstance
|
| BrokerOptions |
Используйте это для настройки следующих параметров брокера:
Примечание. Эти параметры доступны только для PublicClientApplications с помощью потока кода авторизации |
| CacheKVStore |
Хранилище значений ключей для кэша в памяти |
| CacheOptions |
Используйте это для настройки следующих параметров конфигурации кэша:
|
| ClientAssertionCallback | |
| ClientCredentialRequest |
CommonClientCredentialRequest
|
| Configuration |
Использование объекта конфигурации для настройки MSAL и инициализации объекта клиентского приложения
|
| DeviceCodeRequest |
Параметры потока кода устройства Oauth2.
|
| IdTokenClaims |
Тип, описывающий утверждения маркера идентификатора, известные MSAL. |
| InMemoryCache |
Временный тип для обработки объектов данных в памяти с определенными типами |
| InteractiveRequest |
Запрос объекта, переданного пользователем для настройки API getTokenInteractive
|
| JsonCache |
Формат кэша считывается из большого двоичного объекта кэша, предоставленного конфигурации во время создания экземпляра приложения |
| ManagedIdentityConfiguration | |
| ManagedIdentityIdParams | |
| ManagedIdentityRequestParams |
ManagedIdentityRequest
|
| NetworkRequestOptions |
Параметры, разрешенные API-интерфейсами сетевого запроса. |
| NetworkResponse | |
| NodeAuthOptions |
|
| NodeSystemOptions |
Тип для настройки параметров ведения журнала и http-клиента
|
| NodeTelemetryOptions | |
| OnBehalfOfRequest |
|
| RefreshTokenRequest |
CommonRefreshTokenRequest
|
| SerializedAccessTokenEntity |
Тип учетных данных маркера доступа |
| SerializedAccountEntity |
Тип аккаунта |
| SerializedAppMetadataEntity |
Тип AppMetadata |
| SerializedIdTokenEntity |
Тип учетных данных Idtoken |
| SerializedRefreshTokenEntity |
Тип учетных данных маркера обновления |
| SignOutRequest | |
| SilentFlowRequest |
Параметры SilentFlow, передаваемые пользователем для автоматического получения учетных данных
|
| UsernamePasswordRequest |
Параметры UsernamePassword, переданные пользователем для получения учетных данных, примечание. Последняя политика безопасности OAuth 2.0 запрещает предоставление пароля полностью. Этот поток добавляется для внутреннего тестирования.
|
Перечисления
| LogLevel |
Уровень сообщения журнала. |
Переменные
| Azure |
|
| Managed |
Имена источников управляемых удостоверений |
| Protocol |
Режимы протокола, поддерживаемые MSAL. |
| Response |
допустимые значения для response_mode |
| Auth |
Класс AuthErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями. |
| Client |
Строковые константы, используемые кодами ошибок и сообщениями. |
| Client |
Класс ClientConfigurationErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями. |
| Interaction |
Необходимые ошибки взаимодействия, определенные пакетом SDK |
| Prompt |
Мы рассмотрели этот "перечисление" в запросе вместо строки, однако он выглядит так, как допустимый список значений запроса продолжал изменяться за последние пару лет. Существуют некоторые незадокументированные значения запроса для некоторых внутренних партнеров, поэтому выбор универсального типа string вместо перечисления |
| version |
Сведения об переменной
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" }Тип
{ 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
Имена источников управляемых удостоверений
ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }Тип
{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
ProtocolMode
Режимы протокола, поддерживаемые MSAL.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }Тип
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ResponseMode
допустимые значения для response_mode
ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }Тип
{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
AuthErrorMessage
Предупреждение
Теперь этот API является нерекомендуемым.
Use AuthErrorCodes instead
Класс AuthErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }Тип
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
ClientAuthErrorMessage
Предупреждение
Теперь этот API является нерекомендуемым.
Use ClientAuthErrorCodes instead
Строковые константы, используемые кодами ошибок и сообщениями.
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 } }Тип
{ 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
Предупреждение
Теперь этот API является нерекомендуемым.
Use ClientConfigurationErrorCodes instead
Класс ClientConfigurationErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.
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 } }Тип
{ 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
Предупреждение
Теперь этот API является нерекомендуемым.
Use InteractionRequiredAuthErrorCodes instead
Необходимые ошибки взаимодействия, определенные пакетом 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 } }Тип
{ 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
Мы рассмотрели этот "перечисление" в запросе вместо строки, однако он выглядит так, как допустимый список значений запроса продолжал изменяться за последние пару лет. Существуют некоторые незадокументированные значения запроса для некоторых внутренних партнеров, поэтому выбор универсального типа string вместо перечисления
PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }Тип
{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
version
version: "3.8.10"Тип
"3.8.10"