@azure/msal-browser package

Классы

AuthError	Общий класс ошибок, вызванный библиотекой MSAL.js.
AuthenticationHeaderParser	Это вспомогательный класс, который анализирует поддерживаемые заголовки проверки подлинности HTTP-ответа для извлечения и возврата значений вызовов заголовка, которые можно использовать за пределами базовых потоков авторизации.
BrowserAuthError	Класс ошибок библиотеки браузера, вызванный библиотекой MSAL.js для spAs
BrowserConfigurationAuthError	Класс ошибок библиотеки браузера, вызванный библиотекой MSAL.js для spAs
BrowserPerformanceClient
BrowserPerformanceMeasurement
ClientAuthError	Возникает ошибка при возникновении ошибки в клиентском коде, работающем в браузере.
ClientConfigurationError	Возникает ошибка при возникновении ошибки в конфигурации библиотеки MSAL.js.
EventHandler
EventMessageUtils
InteractionRequiredAuthError	Ошибка, возникаемая при необходимости взаимодействия с пользователем.
LocalStorage
Logger	Класс, который упрощает ведение журнала сообщений в определенном месте.
MemoryStorage
NavigationClient
PublicClientApplication	Класс PublicClientApplication — это объект, предоставляемый библиотекой для выполнения функций проверки подлинности и авторизации в одностраничных приложениях для получения маркеров JWT, как описано в потоке кода авторизации OAuth 2.0 с спецификацией PKCE.
PublicClientNext	PublicClientNext — это ранний обзор плановой реализации PublicClientApplication в следующей основной версии MSAL.js. Она содержит поддержку нескольких реализаций API на основе среды выполнения, в которой она работает. Цели этих изменений — обеспечить четкое разделение поведения между различными операционными контекстами (вложенный аутентификация приложений, брокеры платформы, обычный старый браузер и т. д.), обеспечивая согласованную поверхность API для разработчиков. Используйте PublicClientApplication для любых сценариев prod/real-world. Примечание. PublicClientNext является экспериментальным и подвержен критическим изменениям без следующего semver
ServerError	Возникает ошибка при возникновении ошибки с кодом сервера, например недоступности.
SessionStorage
SignedHttpRequest
StubPerformanceClient
UrlString	Класс объектов URL, который может выполнять различные преобразования по строкам URL-адресов.
AuthFlowActionRequiredStateBase	Базовый класс для повторного состояния действия в потоке проверки подлинности.
AuthFlowStateBase	Базовый класс для состояния потока проверки подлинности.
AuthMethodRegistrationChallengeMethodError	Ошибка, возниквшая во время запроса на вызов метода проверки подлинности.
AuthMethodRegistrationChallengeMethodResult	Результат сложного метода проверки подлинности для регистрации. Использует базовый тип состояния, чтобы избежать циклических зависимостей.
AuthMethodRegistrationCompletedState	Состояние, указывающее, что поток регистрации метода проверки подлинности успешно завершен.
AuthMethodRegistrationFailedState	Состояние, указывающее, что поток регистрации метода проверки подлинности завершился сбоем.
AuthMethodRegistrationRequiredState	Состояние, указывающее, что требуется регистрация метода проверки подлинности.
AuthMethodRegistrationSubmitChallengeError	Ошибка, которая произошла во время отправки запроса метода проверки подлинности.
AuthMethodRegistrationSubmitChallengeResult	Результат отправки запроса на регистрацию метода проверки подлинности.
AuthMethodVerificationRequiredState	Состояние, указывающее, что проверка требуется для метода проверки подлинности с вызовом.
CustomAuthAccountData
CustomAuthApiError	Ошибка пользовательского API проверки подлинности.
CustomAuthError
CustomAuthPublicClientApplication
GetAccessTokenResult
GetAccountError	Класс ошибок для получения ошибок учетной записи.
GetAccountResult
GetCurrentAccountAccessTokenError	Класс ошибок для получения ошибок маркера доступа к текущей учетной записи.
HttpError
InvalidArgumentError
InvalidConfigurationError
MethodNotImplementedError
MfaAwaitingState	Состояние, указывающее, что MFA является обязательным и ожидает действия пользователя. Это состояние позволяет разработчику приостановить выполнение перед отправкой кода в электронную почту пользователя.
MfaCompletedState	Состояние, указывающее, что поток MFA успешно завершен.
MfaFailedState	Состояние, указывающее, что поток MFA завершился ошибкой.
MfaRequestChallengeError	Ошибка, возниквшая во время запроса на вызов MFA.
MfaRequestChallengeResult	Результат запроса на вызов MFA. Использует базовый тип состояния, чтобы избежать циклических зависимостей.
MfaSubmitChallengeError	Ошибка, которая произошла во время отправки запроса MFA.
MfaSubmitChallengeResult	Результат отправки запроса MFA.
MfaVerificationRequiredState	Состояние, указывающее, что требуется проверка MFA. Задача была отправлена, и пользователю необходимо предоставить код.
MsalCustomAuthError
NoCachedAccountFoundError
ParsedUrlError
ResetPasswordCodeRequiredState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
ResetPasswordCompletedState	Представляет состояние, указывающее успешное завершение операции сброса пароля.
ResetPasswordError
ResetPasswordFailedState	Состояние операции сброса пароля, которая завершилась сбоем.
ResetPasswordPasswordRequiredState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
ResetPasswordResendCodeError
ResetPasswordResendCodeResult
ResetPasswordStartResult
ResetPasswordState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
ResetPasswordSubmitCodeError
ResetPasswordSubmitCodeResult
ResetPasswordSubmitPasswordError
ResetPasswordSubmitPasswordResult
SignInCodeRequiredState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
SignInCompletedState	Представляет завершенное состояние операции входа. Это состояние указывает, что процесс входа успешно завершен.
SignInContinuationState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
SignInError
SignInFailedState	Представляет состояние операции входа, которая завершилась сбоем.
SignInPasswordRequiredState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
SignInResendCodeError
SignInResendCodeResult
SignInResult
SignInState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
SignInSubmitCodeError
SignInSubmitCodeResult
SignInSubmitPasswordError
SignInSubmitPasswordResult
SignOutError	Класс ошибок выхода.
SignOutResult
SignUpAttributesRequiredState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
SignUpCodeRequiredState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
SignUpCompletedState	Представляет состояние операции регистрации, выполненной успешно.
SignUpError
SignUpFailedState	Представляет состояние операции регистрации, которая завершилась сбоем.
SignUpPasswordRequiredState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
SignUpResendCodeError
SignUpResendCodeResult
SignUpResult
SignUpState	Базовый класс для повторного состояния действия в потоке проверки подлинности.
SignUpSubmitAttributesError
SignUpSubmitAttributesResult
SignUpSubmitCodeError
SignUpSubmitCodeResult
SignUpSubmitPasswordError
SignUpSubmitPasswordResult
UnexpectedError
UnsupportedEnvironmentError
UserAccountAttributeError
UserAlreadySignedInError

Интерфейсы

IController
ILoggerCallback
INavigationClient
INetworkModule	Клиентский сетевой интерфейс для отправки внутренних запросов.
IPerformanceClient
IPublicClientApplication
ITokenCache
IWindowStorage
AuthMethodDetails	Сведения о методе проверки подлинности для регистрации.
AuthenticationMethod
ICustomAuthPublicClientApplication

Псевдонимы типа

AccountInfo	Объект учетной записи со следующей подписью: homeAccountId — идентификатор домашней учетной записи для этого объекта учетной записи среда — сущность, выдавающая маркер, представленный доменом издателя (например, login.microsoftonline.com) tenantId — полный идентификатор клиента или организации, к которому принадлежит эта учетная запись. имя пользователя — preferred_username утверждение id_token, представляющего эту учетную запись. localAccountId — локальный идентификатор учетной записи для конкретного клиента для этого объекта учетной записи, обычно используемый в устаревших случаях name — полное имя для учетной записи, включая имя и имя семейства idToken — маркер необработанного идентификатора idTokenClaims — объект содержит утверждения из маркера идентификатора nativeAccountId — собственный идентификатор учетной записи пользователя tenantProfiles — сопоставление объектов профиля клиента для каждого клиента, прошедшего проверку подлинности учетной записи в браузере. dataBoundary — граница данных, извлеченная из clientInfo
AuthenticationResult
AuthorizationCodeRequest
AuthorizationUrlRequest	Этот тип устарел и будет удален при следующем обновлении основной версии.
AzureCloudOptions	Конкретные параметры AzureCloudInstance azureCloudInstance — строка перечисления, обеспечивающая короткую нотацию для государственных облачных властей и служб soverign и общедоступных облачных служб клиент — подготовка для предоставления сведений о клиенте
BrokerConnectionEvent	Полезные данные для события BrokerConnectionEstablished
BrowserAuthOptions	Это позволяет настроить параметры проверки подлинности в объекте Configuration
BrowserSystemOptions
BrowserTelemetryOptions	Параметры телеметрии
CacheOptions	Используйте это для настройки следующих параметров конфигурации кэша:
ClearCacheRequest	ClearCacheRequest correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. учетная запись — объект учетной записи, из который будет выходить из системы. Все маркеры, привязанные к этой учетной записи, будут сняты.
Configuration	Этот объект позволяет настроить важные элементы функциональных возможностей MSAL и передается в конструктор PublicClientApplication
EndSessionPopupRequest	EndSessionPopupRequest учетная запись — объект учетной записи, из который будет выходить из системы. Все маркеры, привязанные к этой учетной записи, будут сняты. postLogoutRedirectUri — URI для перехода на страницу выхода внутри всплывающего окна. Требуется, чтобы всплывающее окно можно закрыть. центр — центр для отправки запроса на выход. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. idTokenHint — маркер идентификатора, используемый B2C для проверки выхода при необходимости в политике mainWindowRedirectUri — URI для перехода к главному окну после завершения выхода popupWindowAttributes — необязательные атрибуты окна всплывающего окна. popupSize с высотой и шириной, а всплывающее окно с верхней и левой можно задать. logoutHint — строка, указывающая учетную запись, которая выходит из системы, чтобы пропустить средство выбора учетной записи сервера при выходе popupWindowParent — необязательный объект окна, используемый в качестве родительского элемента при открытии всплывающих окон. Использует глобальный, window если он не задан.
EndSessionRequest	EndSessionRequest учетная запись — объект учетной записи, из который будет выходить из системы. Все маркеры, привязанные к этой учетной записи, будут сняты. postLogoutRedirectUri — URI для перехода к странице выхода. центр — центр для отправки запроса на выход. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. idTokenHint — маркер идентификатора, используемый B2C для проверки выхода при необходимости в политике onRedirectNavigate — обратный вызов, который будет передан URL-адрес, к которому будет переходить MSAL. Возврат false в обратном вызове остановит навигацию. logoutHint — строка, указывающая учетную запись, которая выходит из системы, чтобы пропустить средство выбора учетной записи сервера при выходе
EventCallbackFunction
EventError
EventMessage
EventPayload
ExternalTokenResponse	Объект ответа, используемый для загрузки внешних маркеров в кэш. token_type. Указывает значение типа токена. Единственным типом, который поддерживает Azure AD, является носитель. область: области, для которыми действительна access_token. expires_in. Как долго маркер доступа действителен (в секундах). id_token: веб-токен JSON (JWT). Приложение может расшифровать сегменты этого маркера, чтобы запросить сведения о выполнившем вход пользователе. refresh_token: маркер обновления OAuth 2.0. Приложение может использовать этот маркер получения дополнительных маркеров доступа после истечения срока действия текущего маркера доступа. access_token: запрошенный маркер доступа. Приложение может использовать этот маркер для аутентификации в защищенном ресурсе, таком как веб-API. client_info: объект сведений о клиенте
IdTokenClaims	Тип, описывающий утверждения маркера идентификатора, известные MSAL.
InProgressPerformanceEvent
InitializeApplicationRequest	InitializeApplicationRequest: запрос объекта, переданного пользователем для инициализации приложения correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии.
LoadTokenOptions
NavigationOptions	Дополнительные сведения, передаваемые в функции navigateInternal и navigateExternal
NetworkRequestOptions	Параметры, разрешенные API-интерфейсами сетевого запроса.
NetworkResponse
PerformanceCallbackFunction
PerformanceEvent	Измерение производительности, принятое библиотекой, включая метаданные о запросе и приложении.
PopupEvent
PopupPosition
PopupRequest	PopupRequest: запрос объекта, переданного пользователем, чтобы получить код с сервера (первый этап потока предоставления кода авторизации) с всплывющим окном. области — массив областей, к к которые приложение запрашивает доступ. центр — URL-адрес центра, из которого приложение получает маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. redirectUri — URI перенаправления, в котором можно получить ответы проверки подлинности приложением. Он должен точно соответствовать одному из URI перенаправления, зарегистрированным на портале Azure. extraScopesToConsent — области для другого ресурса, когда пользователю требуется предварительное согласие. состояние — значение, включенное в запрос, который также возвращается в ответе маркера. Случайно созданное уникальное значение обычно используется для предотвращения атак на межсайтовые запросы на подделку. Состояние также используется для кодирования сведений о состоянии пользователя в приложении перед выполнением запроса проверки подлинности. запрос . Указывает тип необходимого взаимодействия с пользователем. имя входа: принудит пользователя ввести свои учетные данные по этому запросу, отрицая единый вход нет: гарантирует, что пользователь не будет отображаться с интерактивным запросом. Если запрос не может быть выполнен через единый вход, конечная точка вернет согласие на interaction_required ошибку: активирует диалоговое окно согласия OAuth после входа пользователя, запрашивая у пользователя предоставление разрешений приложению select_account: прерывает единый вход, предоставляя возможность выбора учетных записей в сеансе или любых запоминаемых учетных записей или возможность использовать другую учетную запись: при проверке подлинности пользователя пользователь перейдет к интерфейсу создания учетной записи вместо no_session входа: не будет читать существующий маркер сеанса. После успешной проверки подлинности пользователя EVO не создаст новый сеанс для пользователя. ТОЛЬКО ДЛЯ ВНУТРЕННЕГО ИСПОЛЬЗОВАНИЯ. loginHint — можно использовать для предварительного заполнения поля имени пользователя или электронной почты страницы входа пользователя, если вы знаете имя пользователя или адрес электронной почты заранее. Часто приложения используют этот параметр во время повторной проверки подлинности, уже извлекая имя пользователя из предыдущего входа с помощью утверждения login_hint или preferred_username. sid — идентификатор сеанса, уникальный идентификатор сеанса. Доступно как необязательное утверждение для маркеров идентификаторов. domainHint — предоставляет указание о клиенте или домене, который пользователь должен использовать для входа. Значение указания домена — это зарегистрированный домен для клиента. extraQueryParameters — строка для сопоставления строк настраиваемых параметров запроса, добавленных в вызов /authorize tokenBodyParameters — строка со строковой картой параметров текста запроса пользовательского маркера, добавленных в вызов /token. Используется только при продлении маркеров доступа. tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token утверждения. В случаях, когда Azure администратор клиента AD включил политики условного доступа, и политика не выполнена, исключения будут содержать утверждения, которым необходимо предоставить согласие. nonce — значение, включенное в запрос, возвращаемое в маркере идентификатора. Случайно созданное уникальное значение обычно используется для устранения атак воспроизведения. popupWindowAttributes — необязательные атрибуты окна всплывающего окна. popupSize с высотой и шириной, а всплывающее окно с верхней и левой можно задать. popupWindowParent — необязательный объект окна, используемый в качестве родительского элемента при открытии всплывающих окон. Использует глобальный, window если он не задан.
PopupSize
PopupWindowAttributes	Конфигурации всплывающих окон для настройки измерений и положения всплывающего окна
RedirectRequest	RedirectRequest: запрос объекта, переданного пользователем, чтобы получить код с сервера (первый этап потока предоставления кода авторизации) с полным перенаправлением страницы. области — массив областей, к к которые приложение запрашивает доступ. центр — URL-адрес центра, из которого приложение получает маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. redirectUri — URI перенаправления, в котором можно получить ответы проверки подлинности приложением. Он должен точно соответствовать одному из URI перенаправления, зарегистрированным на портале Azure. extraScopesToConsent — области для другого ресурса, когда пользователю требуется предварительное согласие. состояние — значение, включенное в запрос, который также возвращается в ответе маркера. Случайно созданное уникальное значение обычно используется для предотвращения атак на межсайтовые запросы на подделку. Состояние также используется для кодирования сведений о состоянии пользователя в приложении перед выполнением запроса проверки подлинности. запрос . Указывает тип необходимого взаимодействия с пользователем. имя входа: принудит пользователя ввести свои учетные данные по этому запросу, отрицая единый вход нет: гарантирует, что пользователь не будет отображаться с интерактивным запросом. Если запрос не может быть выполнен через единый вход, конечная точка вернет согласие на interaction_required ошибку: активирует диалоговое окно согласия OAuth после входа пользователя, запрашивая у пользователя предоставление разрешений приложению select_account: прерывает единый вход, предоставляя возможность выбора учетных записей в сеансе или любых запоминаемых учетных записей или возможность использовать другую учетную запись: при проверке подлинности пользователя пользователь перейдет к интерфейсу создания учетной записи вместо no_session входа: не будет читать существующий маркер сеанса. После успешной проверки подлинности пользователя EVO не создаст новый сеанс для пользователя. ТОЛЬКО ДЛЯ ВНУТРЕННЕГО ИСПОЛЬЗОВАНИЯ. loginHint — можно использовать для предварительного заполнения поля имени пользователя или электронной почты страницы входа пользователя, если вы знаете имя пользователя или адрес электронной почты заранее. Часто приложения используют этот параметр во время повторной проверки подлинности, уже извлекая имя пользователя из предыдущего входа с помощью утверждения login_hint или preferred_username. sid — идентификатор сеанса, уникальный идентификатор сеанса. Доступно как необязательное утверждение для маркеров идентификаторов. domainHint — предоставляет указание о клиенте или домене, который пользователь должен использовать для входа. Значение указания домена — это зарегистрированный домен для клиента. extraQueryParameters — строка для сопоставления строк настраиваемых параметров запроса, добавленных в вызов /authorize tokenBodyParameters — строка со строковой картой параметров текста запроса пользовательского маркера, добавленных в вызов /token. Используется только при продлении маркеров доступа. tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token утверждения. В случаях, когда Azure администратор клиента AD включил политики условного доступа, и политика не выполнена, исключения будут содержать утверждения, которым необходимо предоставить согласие. nonce — значение, включенное в запрос, возвращаемое в маркере идентификатора. Случайно созданное уникальное значение обычно используется для устранения атак воспроизведения. redirectStartPage — страница, на которую необходимо вернуться после входаRedirect или полученияTokenRedirect. Это следует использовать только в том случае, если это отличается от URI перенаправления и по умолчанию будет использоваться на странице, которая инициирует запрос. Если для параметра конфигурации navigateToLoginRequestUrl задано значение false, этот параметр будет игнорироваться. onRedirectNavigate — обратный вызов, который будет передан URL-адрес, к которому будет переходить MSAL. Возврат false в обратном вызове остановит навигацию.
SignedHttpRequestOptions
SilentRequest	SilentRequest: запрос объекта, переданного пользователем для получения маркеров из кэша, возобновления истекающего маркера с маркером обновления или получения кода (первый этап потока предоставления кода авторизации) в скрытом iframe. области — массив областей, к к которые приложение запрашивает доступ. центр — URL-адрес центра, из которого приложение получает маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. учетная запись — сущность учетной записи для поиска учетных данных. forceRefresh — принудительно отправляет автоматические запросы на выполнение сетевых вызовов, если значение true. extraQueryParameters — строка для сопоставления строк настраиваемых параметров запроса, добавленных в вызов /authorize. Используется только при продлении маркера обновления. tokenBodyParameters — строка со строковой картой параметров текста запроса пользовательского маркера, добавленных в вызов /token. Используется только при продлении маркеров доступа. tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token. Используется только при продлении маркеров доступа. redirectUri — URI перенаправления, в котором можно получить ответы проверки подлинности приложением. Он должен точно соответствовать одному из URI перенаправления, зарегистрированным на портале Azure. Используется только в тех случаях, когда истек срок действия маркера обновления. cacheLookupPolicy — перечисление различных способов извлечения автоматического маркера. запрос . Указывает тип необходимого взаимодействия с пользователем. нет: убедитесь, что пользователь не отображает интерактивный запрос. Если запрос не может быть выполнен с помощью единого входа, конечная точка вернет ошибку interaction_required no_session: не будет считывать существующий маркер сеанса при проверке подлинности пользователя. После успешной проверки подлинности пользователя EVO не создаст новый сеанс для пользователя. ТОЛЬКО ДЛЯ ВНУТРЕННЕГО ИСПОЛЬЗОВАНИЯ.
SsoSilentRequest	Запрос объекта, передаваемого пользователем в ssoSilent, чтобы получить код с сервера (первый этап потока предоставления кода авторизации) области — массив областей, к которые приложение запрашивает доступ (необязательно для вызовов ssoSilent) утверждения — запрос строковых утверждений, который будет добавлен ко всем вызовам /авторизовать и /token. центр — URL-адрес центра, из которого приложение получает маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. redirectUri — URI перенаправления, в котором можно получить ответы проверки подлинности приложением. Он должен точно соответствовать одному из URI перенаправления, зарегистрированным на портале Azure. extraScopesToConsent — области для другого ресурса, когда пользователю требуется предварительное согласие. состояние — значение, включенное в запрос, который также возвращается в ответе маркера. Случайно созданное уникальное значение обычно используется для предотвращения атак на межсайтовые запросы на подделку. Состояние также используется для кодирования сведений о состоянии пользователя в приложении перед выполнением запроса проверки подлинности. запрос . Указывает тип необходимого взаимодействия с пользователем. имя входа: принудит пользователя ввести свои учетные данные по этому запросу, отрицая единый вход нет: гарантирует, что пользователь не будет отображаться с интерактивным запросом. Если запрос не может быть выполнен с помощью единого входа, конечная точка вернет согласие на interaction_required ошибку: активирует диалоговое окно согласия OAuth после входа пользователя, запрашивая у пользователя предоставление разрешений приложению select_account: прерывает единый вход, предоставляя возможность выбора учетных записей в сеансе или любых запоминаемых учетных записей или возможность использовать другую учетную запись: при проверке подлинности пользователя пользователь перейдет к интерфейсу создания учетной записи вместо no_session входа: не будет читать существующий маркер сеанса. После успешной проверки подлинности пользователя EVO не создаст новый сеанс для пользователя. ТОЛЬКО ДЛЯ ВНУТРЕННЕГО ИСПОЛЬЗОВАНИЯ. loginHint — можно использовать для предварительного заполнения поля имени пользователя или электронной почты страницы входа пользователя, если вы знаете имя пользователя или адрес электронной почты заранее. Часто приложения используют этот параметр во время повторной проверки подлинности, уже извлекая имя пользователя из предыдущего входа с помощью утверждения login_hint или preferred_username. sid — идентификатор сеанса, уникальный идентификатор сеанса. Доступно как необязательное утверждение для маркеров идентификаторов. domainHint — предоставляет указание о клиенте или домене, который пользователь должен использовать для входа. Значение указания домена — это зарегистрированный домен для клиента. extraQueryParameters — строка для сопоставления строк настраиваемых параметров запроса, добавленных в вызов /authorize tokenBodyParameters — строка со строковой картой параметров текста запроса пользовательского маркера, добавленных в вызов /token. Используется только при продлении маркеров доступа. tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token nonce — значение, включенное в запрос, возвращаемое в маркере идентификатора. Случайно созданное уникальное значение обычно используется для устранения атак воспроизведения.
TenantProfile	Сведения об учетной записи, которые зависят от клиентов одного пользователя
AccessTokenRetrievalInputs
AccountRetrievalInputs
AuthMethodRegistrationChallengeMethodResultState	Определение типа для возможных состояний в AuthMethodRegistrationChallengeMethodResult.
AuthMethodRegistrationSubmitChallengeResultState	Определение типа для возможных состояний в AuthMethodRegistrationSubmitChallengeResult.
CustomAuthConfiguration
GetAccessTokenResultState	Возможные состояния для GetAccessTokenResult. Сюда входит следующее: GetAccessTokenCompletedState: маркер доступа был успешно получен. GetAccessTokenFailedState: сбой извлечения маркера доступа.
GetAccountResultState	Возможные состояния для GetAccountResult. Сюда входит следующее: GetAccountCompletedState: учетная запись успешно извлечена. GetAccountFailedState: сбой извлечения учетной записи.
MfaRequestChallengeResultState	Возможные состояния для MfaRequestChallengeResult. Сюда входит следующее: MfaVerificationRequiredState: пользователь должен проверить свою проблему. MfafailedState: сбой запроса MFA.
MfaSubmitChallengeResultState
ResetPasswordInputs
ResetPasswordResendCodeResultState	Возможные состояния для ResetPasswordResendCodeResult. Сюда входит следующее: ResetPasswordCodeRequiredState: для процесса сброса пароля требуется код. ResetPasswordFailedState: сбой процесса сброса пароля.
ResetPasswordStartResultState	Возможные состояния для resetPasswordStartResult. Сюда входит следующее: ResetPasswordCodeRequiredState: для процесса сброса пароля требуется код. ResetPasswordFailedState: сбой процесса сброса пароля.
ResetPasswordSubmitCodeResultState	Возможные состояния для ResetPasswordSubmitCodeResult. Сюда входит следующее: ResetPasswordPasswordRequiredState: для процесса сброса пароля требуется пароль. ResetPasswordFailedState: сбой процесса сброса пароля.
ResetPasswordSubmitPasswordResultState	Возможные состояния для ResetPasswordSubmitPasswordResult. Сюда входит следующее: ResetPasswordCompletedState: процесс сброса пароля успешно завершен. ResetPasswordFailedState: сбой процесса сброса пароля.
SignInInputs
SignInResendCodeResultState	Возможные состояния для SignInResendCodeResult. Сюда входит следующее: SignInCodeRequiredState: для процесса входа требуется код. SignInFailedState: сбой процесса входа.
SignInResultState	Возможные состояния для SignInResult. Сюда входит следующее: SignInCodeRequiredState: для процесса входа требуется код. SignInPasswordRequiredState: для процесса входа требуется пароль. SignInFailedState: сбой процесса входа. SignInCompletedState: процесс входа завершен. AuthMethodRegistrationRequiredState: для процесса входа требуется регистрация метода проверки подлинности. MfaAwaitingState: для процесса входа требуется MFA.
SignInSubmitCodeResultState	Возможные состояния SignInSubmitCodeResult. Сюда входит следующее: SignInCompletedState: процесс входа успешно завершен. SignInFailedState: сбой процесса входа. AuthMethodRegistrationRequiredState: пользователю необходимо зарегистрировать метод проверки подлинности. MfaAwaitingState: пользователь находится в состоянии ожидания многофакторной проверки подлинности (MFA).
SignInSubmitPasswordResultState	Возможные состояния SignInSubmitPasswordResult. Сюда входит следующее: SignInCompletedState: процесс входа успешно завершен. SignInFailedState: сбой процесса входа. AuthMethodRegistrationRequiredState: для процесса входа требуется регистрация метода проверки подлинности. MfaAwaitingState: для процесса входа требуется MFA.
SignInWithContinuationTokenInputs
SignOutResultState	Возможные состояния для SignOutResult. Сюда входит следующее: SignOutCompletedState: операция выхода прошла успешно. SignOutFailedState: сбой операции выхода.
SignUpInputs
SignUpResendCodeResultState	Возможные состояния для SignUpResendCodeResult. Сюда входит следующее: SignUpCodeRequiredState: для процесса регистрации требуется код. SignUpFailedState: сбой процесса регистрации.
SignUpResultState	Возможные состояния для SignUpResult. Сюда входит следующее: SignUpCodeRequiredState: для процесса регистрации требуется код. SignUpPasswordRequiredState: для процесса регистрации требуется пароль. SignUpAttributesRequiredState: процесс регистрации требует дополнительных атрибутов. SignUpFailedState: сбой процесса регистрации.
SignUpSubmitAttributesResultState	Возможные состояния для SignUpSubmitAttributesResult. Сюда входит следующее: SignUpCompletedState: процесс регистрации успешно завершен. SignUpFailedState: сбой процесса регистрации.
SignUpSubmitCodeResultState	Возможные состояния для SignUpSubmitCodeResult. Сюда входит следующее: SignUpPasswordRequiredState: для процесса регистрации требуется пароль. SignUpAttributesRequiredState: процесс регистрации требует дополнительных атрибутов. SignUpCompletedState: процесс регистрации успешно завершен. SignUpFailedState: сбой процесса регистрации.
SignUpSubmitPasswordResultState	Возможные состояния для SignUpSubmitPasswordResult. Сюда входит следующее: SignUpAttributesRequiredState: процесс регистрации требует дополнительных атрибутов. SignUpCompletedState: процесс регистрации успешно завершен. SignUpFailedState: сбой процесса регистрации.
UserAccountAttributes

Перечисления

InteractionType
PerformanceEvents	Перечисление операций, инструментированных с помощью их производительности, измеряется с помощью PerformanceClient.
LogLevel	Уровень сообщения журнала.

Функции

createNestablePublicClientApplication(Configuration)	создает NestedAppAuthController и передает его в PublicClientApplication, возвращается в StandardController, если NestedAppAuthController недоступен
createStandardPublicClientApplication(Configuration)	создает PublicClientApplication с помощью StandardController
isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)	Проверяет, доступен ли брокер платформы в текущей среде.

Переменные

ApiId	Коды API для целей телеметрии. 0-99 Автоматический поток 800-899 Auth Code Flow 900-999 Miscellaneous
AuthenticationScheme	Тип запроса проверки подлинности
AzureCloudInstance
BrowserCacheLocation
CacheLookupPolicy
EventType
InteractionStatus	Типы взаимодействия в настоящее время выполняется. Используется в событиях в библиотеках оболочки для вызова функций при выполнении определенного взаимодействия или завершения всех взаимодействий.
JsonWebTokenTypes
ProtocolMode	Режимы протокола, поддерживаемые MSAL.
ServerResponseType	допустимые значения для типа ответа сервера
WrapperSKU
AuthErrorMessage	Класс AuthErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.
BrowserAuthErrorMessage	Класс BrowserAuthErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.
BrowserConfigurationAuthErrorMessage	Класс BrowserAuthErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.
ClientAuthErrorMessage	Строковые константы, используемые кодами ошибок и сообщениями.
ClientConfigurationErrorMessage	Класс ClientConfigurationErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.
DEFAULT_IFRAME_TIMEOUT_MS
InteractionRequiredAuthErrorMessage	Необходимые ошибки взаимодействия, определенные пакетом SDK
OIDC_DEFAULT_SCOPES
PromptValue	Мы рассмотрели этот "перечисление" в запросе вместо строки, однако он выглядит так, как допустимый список значений запроса продолжал изменяться за последние пару лет. Существуют некоторые незадокументированные значения запроса для некоторых внутренних партнеров, поэтому выбор универсального типа string вместо перечисления
stubbedPublicClientApplication
version

Сведения о функции

createNestablePublicClientApplication(Configuration)

создает NestedAppAuthController и передает его в PublicClientApplication, возвращается в StandardController, если NestedAppAuthController недоступен

function createNestablePublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Параметры

configuration

Configuration

Возвращаемое значение

Promise<IPublicClientApplication>

IPublicClientApplication

createStandardPublicClientApplication(Configuration)

создает PublicClientApplication с помощью StandardController

function createStandardPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Параметры

configuration

Configuration

Возвращаемое значение

Promise<IPublicClientApplication>

IPublicClientApplication

isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)

Проверяет, доступен ли брокер платформы в текущей среде.

function isPlatformBrokerAvailable(loggerOptions?: LoggerOptions, perfClient?: IPerformanceClient, correlationId?: string, domConfig?: boolean): Promise<boolean>

Параметры

loggerOptions

LoggerOptions

perfClient

IPerformanceClient

correlationId

string

domConfig

boolean

Возвращаемое значение

Promise<boolean>

Сведения об переменной

ApiId

Коды API для целей телеметрии. 0-99 Автоматический поток 800-899 Auth Code Flow 900-999 Miscellaneous

ApiId: { acquireTokenByCode: 866, acquireTokenPopup: 862, acquireTokenRedirect: 861, acquireTokenSilent_authCode: 864, acquireTokenSilent_silentFlow: 61, handleRedirectPromise: 865, hydrateCache: 963, loadExternalTokens: 964, logout: 961, logoutPopup: 962, ssoSilent: 863 }

Тип

{ acquireTokenByCode: 866, acquireTokenPopup: 862, acquireTokenRedirect: 861, acquireTokenSilent_authCode: 864, acquireTokenSilent_silentFlow: 61, handleRedirectPromise: 865, hydrateCache: 963, loadExternalTokens: 964, logout: 961, logoutPopup: 962, ssoSilent: 863 }

AuthenticationScheme

Тип запроса проверки подлинности

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

Тип

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

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

BrowserCacheLocation

BrowserCacheLocation: { LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }

Тип

{ LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }

CacheLookupPolicy

CacheLookupPolicy: { AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }

Тип

{ AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }

EventType

EventType: { ACCOUNT_ADDED: "msal:accountAdded", ACCOUNT_REMOVED: "msal:accountRemoved", ACQUIRE_TOKEN_BY_CODE_FAILURE: "msal:acquireTokenByCodeFailure", ACQUIRE_TOKEN_BY_CODE_START: "msal:acquireTokenByCodeStart", ACQUIRE_TOKEN_BY_CODE_SUCCESS: "msal:acquireTokenByCodeSuccess", ACQUIRE_TOKEN_FAILURE: "msal:acquireTokenFailure", ACQUIRE_TOKEN_NETWORK_START: "msal:acquireTokenFromNetworkStart", ACQUIRE_TOKEN_START: "msal:acquireTokenStart", ACQUIRE_TOKEN_SUCCESS: "msal:acquireTokenSuccess", ACTIVE_ACCOUNT_CHANGED: "msal:activeAccountChanged", BROKER_CONNECTION_ESTABLISHED: "msal:brokerConnectionEstablished", HANDLE_REDIRECT_END: "msal:handleRedirectEnd", HANDLE_REDIRECT_START: "msal:handleRedirectStart", INITIALIZE_END: "msal:initializeEnd", INITIALIZE_START: "msal:initializeStart", LOGIN_FAILURE: "msal:loginFailure", LOGIN_START: "msal:loginStart", LOGIN_SUCCESS: "msal:loginSuccess", LOGOUT_END: "msal:logoutEnd", LOGOUT_FAILURE: "msal:logoutFailure", LOGOUT_START: "msal:logoutStart", LOGOUT_SUCCESS: "msal:logoutSuccess", POPUP_OPENED: "msal:popupOpened", RESTORE_FROM_BFCACHE: "msal:restoreFromBFCache", SSO_SILENT_FAILURE: "msal:ssoSilentFailure", SSO_SILENT_START: "msal:ssoSilentStart", SSO_SILENT_SUCCESS: "msal:ssoSilentSuccess" }

Тип

{ ACCOUNT_ADDED: "msal:accountAdded", ACCOUNT_REMOVED: "msal:accountRemoved", ACQUIRE_TOKEN_BY_CODE_FAILURE: "msal:acquireTokenByCodeFailure", ACQUIRE_TOKEN_BY_CODE_START: "msal:acquireTokenByCodeStart", ACQUIRE_TOKEN_BY_CODE_SUCCESS: "msal:acquireTokenByCodeSuccess", ACQUIRE_TOKEN_FAILURE: "msal:acquireTokenFailure", ACQUIRE_TOKEN_NETWORK_START: "msal:acquireTokenFromNetworkStart", ACQUIRE_TOKEN_START: "msal:acquireTokenStart", ACQUIRE_TOKEN_SUCCESS: "msal:acquireTokenSuccess", ACTIVE_ACCOUNT_CHANGED: "msal:activeAccountChanged", BROKER_CONNECTION_ESTABLISHED: "msal:brokerConnectionEstablished", HANDLE_REDIRECT_END: "msal:handleRedirectEnd", HANDLE_REDIRECT_START: "msal:handleRedirectStart", INITIALIZE_END: "msal:initializeEnd", INITIALIZE_START: "msal:initializeStart", LOGIN_FAILURE: "msal:loginFailure", LOGIN_START: "msal:loginStart", LOGIN_SUCCESS: "msal:loginSuccess", LOGOUT_END: "msal:logoutEnd", LOGOUT_FAILURE: "msal:logoutFailure", LOGOUT_START: "msal:logoutStart", LOGOUT_SUCCESS: "msal:logoutSuccess", POPUP_OPENED: "msal:popupOpened", RESTORE_FROM_BFCACHE: "msal:restoreFromBFCache", SSO_SILENT_FAILURE: "msal:ssoSilentFailure", SSO_SILENT_START: "msal:ssoSilentStart", SSO_SILENT_SUCCESS: "msal:ssoSilentSuccess" }

InteractionStatus

Типы взаимодействия в настоящее время выполняется. Используется в событиях в библиотеках оболочки для вызова функций при выполнении определенного взаимодействия или завершения всех взаимодействий.

InteractionStatus: { AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }

Тип

{ AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }

JsonWebTokenTypes

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

Тип

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

ProtocolMode

Режимы протокола, поддерживаемые MSAL.

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

Тип

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

ServerResponseType

Предупреждение

Теперь этот API является нерекомендуемым.

Use ResponseMode instead

допустимые значения для типа ответа сервера

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

Тип

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

WrapperSKU

WrapperSKU: { Angular: "@azure/msal-angular", React: "@azure/msal-react" }

Тип

{ Angular: "@azure/msal-angular", React: "@azure/msal-react" }

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

BrowserAuthErrorMessage

Предупреждение

Теперь этот API является нерекомендуемым.

Use exported BrowserAuthErrorCodes instead. In your app you can do :

import { BrowserAuthErrorCodes } from "@azure/msal-browser";

Класс BrowserAuthErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.

BrowserAuthErrorMessage: { authCodeOrNativeAccountRequired: { code: string, desc: string }, authCodeRequired: { code: string, desc: string }, authRequestNotSet: { code: string, desc: string }, blockAcquireTokenInPopupsError: { code: string, desc: string }, blockTokenRequestsInHiddenIframeError: { code: string, desc: string }, cryptoDoesNotExist: { code: string, desc: string }, databaseNotOpen: { code: string, desc: string }, databaseUnavailable: { code: string, desc: string }, emptyNavigateUriError: { code: string, desc: string }, emptyWindowError: { code: string, desc: string }, failedToParseNetworkResponse: { code: string, desc: string }, getRequestFailed: { code: string, desc: string }, hashDoesNotContainKnownPropertiesError: { code: string, desc: string }, hashDoesNotContainStateError: { code: string, desc: string }, hashEmptyError: { code: string, desc: string }, iframeClosedPrematurelyError: { code: string, desc: string }, interactionInProgress: { code: string, desc: string }, invalidBase64StringError: { code: string, desc: string }, invalidCacheType: { code: string, desc: string }, invalidPopTokenRequest: { code: string, desc: string }, monitorIframeTimeoutError: { code: string, desc: string }, monitorPopupTimeoutError: { code: string, desc: string }, nativeConnectionNotEstablished: { code: string, desc: string }, nativeExtensionNotInstalled: { code: string, desc: string }, nativeHandshakeTimeout: { code: string, desc: string }, nativePromptNotSupported: { code: string, desc: string }, noAccountError: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, noTokenRequestCacheError: { code: string, desc: string }, notInBrowserEnvironment: { code: string, desc: string }, pkceNotGenerated: { code: string, desc: string }, popupWindowError: { code: string, desc: string }, postRequestFailed: { code: string, desc: string }, redirectInIframeError: { code: string, desc: string }, signingKeyNotFoundInStorage: { code: string, desc: string }, silentLogoutUnsupportedError: { code: string, desc: string }, silentPromptValueError: { code: string, desc: string }, spaCodeAndNativeAccountPresent: { code: string, desc: string }, stateInteractionTypeMismatchError: { code: string, desc: string }, unableToAcquireTokenFromNativePlatform: { code: string, desc: string }, unableToLoadTokenError: { code: string, desc: string }, unableToParseStateError: { code: string, desc: string }, unableToParseTokenRequestCacheError: { code: string, desc: string }, uninitializedPublicClientApplication: { code: string, desc: string }, userCancelledError: { code: string, desc: string } }

Тип

{ authCodeOrNativeAccountRequired: { code: string, desc: string }, authCodeRequired: { code: string, desc: string }, authRequestNotSet: { code: string, desc: string }, blockAcquireTokenInPopupsError: { code: string, desc: string }, blockTokenRequestsInHiddenIframeError: { code: string, desc: string }, cryptoDoesNotExist: { code: string, desc: string }, databaseNotOpen: { code: string, desc: string }, databaseUnavailable: { code: string, desc: string }, emptyNavigateUriError: { code: string, desc: string }, emptyWindowError: { code: string, desc: string }, failedToParseNetworkResponse: { code: string, desc: string }, getRequestFailed: { code: string, desc: string }, hashDoesNotContainKnownPropertiesError: { code: string, desc: string }, hashDoesNotContainStateError: { code: string, desc: string }, hashEmptyError: { code: string, desc: string }, iframeClosedPrematurelyError: { code: string, desc: string }, interactionInProgress: { code: string, desc: string }, invalidBase64StringError: { code: string, desc: string }, invalidCacheType: { code: string, desc: string }, invalidPopTokenRequest: { code: string, desc: string }, monitorIframeTimeoutError: { code: string, desc: string }, monitorPopupTimeoutError: { code: string, desc: string }, nativeConnectionNotEstablished: { code: string, desc: string }, nativeExtensionNotInstalled: { code: string, desc: string }, nativeHandshakeTimeout: { code: string, desc: string }, nativePromptNotSupported: { code: string, desc: string }, noAccountError: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, noTokenRequestCacheError: { code: string, desc: string }, notInBrowserEnvironment: { code: string, desc: string }, pkceNotGenerated: { code: string, desc: string }, popupWindowError: { code: string, desc: string }, postRequestFailed: { code: string, desc: string }, redirectInIframeError: { code: string, desc: string }, signingKeyNotFoundInStorage: { code: string, desc: string }, silentLogoutUnsupportedError: { code: string, desc: string }, silentPromptValueError: { code: string, desc: string }, spaCodeAndNativeAccountPresent: { code: string, desc: string }, stateInteractionTypeMismatchError: { code: string, desc: string }, unableToAcquireTokenFromNativePlatform: { code: string, desc: string }, unableToLoadTokenError: { code: string, desc: string }, unableToParseStateError: { code: string, desc: string }, unableToParseTokenRequestCacheError: { code: string, desc: string }, uninitializedPublicClientApplication: { code: string, desc: string }, userCancelledError: { code: string, desc: string } }

BrowserConfigurationAuthErrorMessage

Предупреждение

Теперь этот API является нерекомендуемым.

Use BrowserAuthErrorCodes instead

Класс BrowserAuthErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.

BrowserConfigurationAuthErrorMessage: { inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { code: string, desc: string } }

Тип

{ inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { 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 } }

DEFAULT_IFRAME_TIMEOUT_MS

DEFAULT_IFRAME_TIMEOUT_MS: 10000

Тип

10000

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

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

Тип

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 }

stubbedPublicClientApplication

stubbedPublicClientApplication: IPublicClientApplication

Тип

IPublicClientApplication

version

version: "4.30.0"

Тип

"4.30.0"