@azure/msal-common package

Классы

AuthError	Общий класс ошибок, вызванный библиотекой MSAL.js.
AuthenticationHeaderParser	Это вспомогательный класс, который анализирует поддерживаемые заголовки проверки подлинности HTTP-ответа для извлечения и возврата значений вызовов заголовка, которые можно использовать за пределами базовых потоков авторизации.
CacheError	Ошибка, возникаемая при возникновении ошибки в кэше
ClientAuthError	Возникает ошибка при возникновении ошибки в клиентском коде, работающем в браузере.
ClientConfigurationError	Возникает ошибка при возникновении ошибки в конфигурации библиотеки MSAL.js.
InteractionRequiredAuthError	Ошибка, возникаемая при необходимости взаимодействия с пользователем.
Logger	Класс, который упрощает ведение журнала сообщений в определенном месте.
NetworkError	Представляет ошибки, связанные с сетью
PerformanceClient
PlatformBrokerError	Класс ошибок для ошибок среды выполнения MSAL, которые сохраняют подробные сведения брокера
ProtocolUtils	Класс, предоставляющий вспомогательные функции для определенных значений протокола OAuth 2.0
ScopeSet	Класс ScopeSet создает набор областей. Области являются нечувствительными к регистру, уникальными значениями, поэтому объект Set в JS имеет наибольшее значение для реализации этого класса. Все области обрезаются и преобразуются в строки нижнего регистра в функциях пересечения и объединения, чтобы обеспечить уникальность строк.
ServerError	Возникает ошибка при возникновении ошибки с кодом сервера, например недоступности.
StubPerformanceClient
UrlString	Класс объектов URL, который может выполнять различные преобразования по строкам URL-адресов.
TokenCacheContext	Этот экземпляр класса помогает отслеживать изменения памяти, упрощающие чтение и запись в постоянный кэш.

Интерфейсы

ICrypto	Интерфейс для функций шифрования, используемых библиотекой
ILoggerCallback
INetworkModule	Клиентский сетевой интерфейс для отправки внутренних запросов.
IPerformanceClient
IPerformanceMeasurement
IUri	Интерфейс, описывающий компоненты URI.
PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

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

AccessTokenEntity	Тип кэша маркеров доступа
AccountFilter	Учетная запись: <home_account_id-среда-область><><*>
AccountInfo	Объект учетной записи со следующей подписью: homeAccountId — идентификатор домашней учетной записи для этого объекта учетной записи среда — сущность, выдавающая маркер, представленный доменом издателя (например, login.microsoftonline.com) tenantId — полный идентификатор клиента или организации, к которому принадлежит эта учетная запись. имя пользователя — preferred_username утверждение id_token, представляющего эту учетную запись. localAccountId — локальный идентификатор учетной записи для конкретного клиента для этого объекта учетной записи, обычно используемый в устаревших случаях name — полное имя для учетной записи, включая имя и имя семейства idToken — маркер необработанного идентификатора idTokenClaims — объект содержит утверждения из маркера идентификатора nativeAccountId — собственный идентификатор учетной записи пользователя tenantProfiles — сопоставление объектов профиля клиента для каждого клиента, прошедшего проверку подлинности учетной записи в браузере. dataBoundary — граница данных, извлеченная из clientInfo
ActiveAccountFilters
AppMetadataEntity	Тип кэша метаданных приложения
ApplicationTelemetry	Данные телеметрии, отправленные по запросу appName: уникальное строковое имя приложения appVersion: версия приложения с помощью MSAL
AuthenticationResult	Результат, возвращенный из конечной точки маркера центра. uniqueId — oid или sub утверждение из маркера идентификатора tenantId — tid утверждение из маркера идентификатора области — области, проверенные для соответствующего маркера учетная запись — представление объекта учетной записи пользователя, вошедшего в систему. idToken — маркер идентификатора, полученный в ответе idTokenClaims — утверждения маркера идентификатора MSAL accessToken — маркер доступа или сертификат SSH, полученный в ответе fromCache — логический знак, обозначающий, поступил ли маркер из кэша expiresOn — объект Javascript Date, представляющий относительный срок действия маркера доступа extExpiresOn — объект Javascript Date, представляющий расширенный относительный срок действия маркера доступа в случае сбоя сервера refreshOn — объект Date Javascript, представляющий относительное время, пока маркер доступа не должен быть обновлен. состояние — значение, переданное пользователем в запросе familyId — идентификатор семейства, обычно используемый только для маркеров обновления requestId — идентификатор запроса, возвращенный в ответе
AuthorityOptions
AuthorizationCodePayload	Ответ возвращается после обработки строки запроса ответа кода или фрагмента.
AuthorizeResponse	Свойства ответа, которые могут быть возвращены конечной точкой /authorize
AzureCloudOptions	Конкретные параметры AzureCloudInstance azureCloudInstance — строка перечисления, обеспечивающая короткую нотацию для государственных облачных властей и служб soverign и общедоступных облачных служб клиент — подготовка для предоставления сведений о клиенте
AzureRegion
AzureRegionConfiguration
BaseAuthRequest	BaseAuthRequest центр — URL-адрес центра, служба маркеров безопасности (STS), из которой MSAL получит маркеры. По умолчанию — https://login.microsoftonline.com/common. Если для всех запросов используется один и тот же центр, центр должен задать объект клиентского приложения, а не запрашивать, чтобы избежать разрешения конечных точек центра несколько раз. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. области — массив областей, к к которые приложение запрашивает доступ. authenticationScheme — тип полученного маркера. По умолчанию используется значение "Носитель". Можно также ввести "pop" или "SSH". утверждения — запрос строковых утверждений, который будет добавлен ко всем вызовам /авторизовать и /token. shrClaims — объект строковых утверждений, который будет добавлен в подписанный HTTP-запрос shrNonce — созданная сервером метка времени, зашифрованная и закодированная base64URL, которая будет добавлена в подписанный HTTP-запрос. shrOptions — объект, содержащий параметры подписанного HTTP-запроса resourceRequestMethod — тип HTTP-запроса, используемый для запроса данных из ресурса (например, GET, POST и т. д.). Используется для потоков подтверждения владения. resourceRequestUri — URI, для этого маркера будет использоваться. Используется для потоков подтверждения владения. sshJwk — строковый веб-ключ JSON, представляющий открытый ключ, который может быть подписан сертификатом SSH. sshKid — идентификатор ключа, который однозначно идентифицирует открытый ключ SSH, упомянутый выше. azureCloudOptions — удобные строки перечисления для пользователей для предоставления идентификаторов общедоступного и суверенного облака requestedClaimsHash - SHA 256 хэш-строка запрошенной строки утверждений, используемая в составе ключа кэша маркеров доступа, чтобы маркеры можно было фильтровать по запрошенным утверждениям tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token tokenBodyParameters — строка на строку карты пользовательских параметров, добавленных в текст вызова /token storeInCache — объект, содержащий логические значения, указывающие, следует ли хранить маркеры в кэше или нет (значение по умолчанию — true) ScenarioId — идентификатор сценария для отслеживания пользовательских запросов пользователей popKid — идентификатор ключа для идентификации открытого ключа для запроса токена PoP embeddedClientId — внедренный идентификатор клиента. При указании идентификатор клиента брокера (brk_client_id) и параметры uri перенаправления (brk_redirect_uri) задаются со значениями из конфигурации, переопределяя соответствующие дополнительные параметры, если они присутствуют. httpMethod — метод HTTP, используемый для запроса /authorize. Значение GET по умолчанию, но может иметь значение POST, если запросу требуются параметры тела authorizePostBodyParameters — строка со строковой картой настраиваемых параметров, добавленных в текст вызова /authorize, если для httpMethod задано значение POST skipBrokerClaims — если используется поток с брокером (например, при наличии парам брокера или embeddedClientId), клиентCapabilities из конфигурации будет исключен из утверждений; игнорируется для потоков, не являющихся брокерами.
CacheOptions	Это позволяет настроить настройки кэша учетных данных в объекте ClientConfiguration claimsBasedCachingEnabled — задает, следует ли кэшировать маркеры на основе хэша утверждений. По умолчанию — false.
CcsCredential
ClientInfo	Объект сведений о клиенте, состоящий из: uid: идентификатор пользователя: идентификатор клиента xms_tdbr: необязательный, только для клиентов, отличных от США
CommonAuthorizationCodeRequest	Запрос объекта, передаваемого пользователем, для получения маркера с сервера, обменивающегося допустимым кодом авторизации (второй этап потока кода авторизации OAuth2.0) области — массив областей, к к которые приложение запрашивает доступ. утверждения — запрос строковых утверждений, который будет добавлен ко всем вызовам /авторизовать и /token. центр: — URL-адрес центра, служба маркеров безопасности (STS), из которой MSAL получит маркеры. Если центр задан в объекте клиентского приложения, это переопределит это значение. Переопределение значения приведет к тому, что проверка центра будет выполняться каждый раз. Если один и тот же центр будет использоваться для всех запросов, задайте для объекта приложения вместо запросов. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. redirectUri — универсальный код ресурса (URI перенаправления) приложения, на который центр перенаправляется после ввода учетных данных и согласия пользователя. Он должен точно соответствовать одному из URI перенаправления, зарегистрированных на портале. код — authorization_code, полученное пользователем в первой части потока. codeVerifier — тот же code_verifier, который использовался для получения authorization_code. Требуется, если PKCE использовался в запросе на предоставление кода авторизации. Дополнительные сведения см. в rfC PKCE: https://tools.ietf.org/html/rfc7636 resourceRequestMethod — тип HTTP-запроса, используемый для запроса данных из ресурса (например, GET, POST и т. д.). Используется для потоков подтверждения владения. resourceRequestUri — URI, для этого маркера будет использоваться. Используется для потоков подтверждения владения. enableSpaAuthCode — включает аквицию кода авторизации spa (только конфиденциальные клиенты) tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token
CommonAuthorizationUrlRequest	Запрос объекта, передаваемого пользователем, для получения кода с сервера (первый этап потока предоставления кода авторизации) области — массив областей, к к которые приложение запрашивает доступ. утверждения — запрос строковых утверждений, который будет добавлен ко всем вызовам /авторизовать и /token. центр — URL-адрес центра, из которого приложение получает маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. redirectUri — URI перенаправления, в котором можно получить ответы проверки подлинности приложением. Он должен точно соответствовать одному из URI перенаправления, зарегистрированным на портале Azure. extraScopesToConsent — области для другого ресурса, когда пользователю требуется предварительное согласие. responseMode — указывает метод, который следует использовать для отправки результата проверки подлинности в приложение. Может быть запрос, form_post или фрагмент. Если значение не передается, по умолчанию выполняется запрос. codeChallenge — используется для защиты предоставления кода авторизации с помощью подтверждения ключа для кода Exchange (PKCE). Дополнительные сведения см. в rcF PKCE:https://tools.ietf.org/html/rfc7636 codeChallengeMethod — метод, используемый для кодирования проверяющего кода для параметра вызова кода. Может быть "простой" или "S256". При исключении предполагается, что вызов кода является открытым. Дополнительные сведения см. в rcF PKCE: https://tools.ietf.org/html/rfc7636 состояние — значение, включенное в запрос, который также возвращается в ответе маркера. Случайно созданное уникальное значение обычно используется для предотвращения атак на межсайтовые запросы на подделку. Состояние также используется для кодирования сведений о состоянии пользователя в приложении перед выполнением запроса проверки подлинности. запрос . Указывает тип необходимого взаимодействия с пользователем. имя входа: принудит пользователя ввести свои учетные данные по этому запросу, отрицая единый вход нет: гарантирует, что пользователь не будет отображаться с интерактивным запросом. Если запрос не может быть выполнен через единый вход, конечная точка вернет согласие на interaction_required ошибку: активирует диалоговое окно согласия OAuth после входа пользователя, запрашивая у пользователя предоставление разрешений приложению select_account: прерывает единый вход, предоставляя возможность выбора учетных записей в сеансе или любых запоминаемых учетных записей или возможность использовать другую учетную запись: при проверке подлинности пользователя пользователь перейдет к интерфейсу создания учетной записи вместо no_session входа: не будет читать существующий маркер сеанса. После успешной проверки подлинности пользователя EVO не создаст новый сеанс для пользователя. ТОЛЬКО ДЛЯ ВНУТРЕННЕГО ИСПОЛЬЗОВАНИЯ. account — AccountInfo, полученный из API getAccount. Будет использоваться в определенных сценариях для создания login_hint, если параметры loginHint и sid не предоставляются. loginHint — можно использовать для предварительного заполнения поля имени пользователя или электронной почты страницы входа пользователя, если вы знаете имя пользователя или адрес электронной почты заранее. Часто приложения используют этот параметр во время повторной проверки подлинности, уже извлекая имя пользователя из предыдущего входа с помощью утверждения preferred_username. sid — идентификатор сеанса, уникальный идентификатор сеанса. Доступно как необязательное утверждение для маркеров идентификаторов. domainHint — предоставляет указание о клиенте или домене, который пользователь должен использовать для входа. Значение указания домена — это зарегистрированный домен для клиента. extraQueryParameters — строка для сопоставления строк настраиваемых параметров запроса, добавленных в вызов /authorize tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token nonce — значение, включенное в запрос, возвращаемое в маркере идентификатора. Случайно созданное уникальное значение обычно используется для устранения атак воспроизведения. resourceRequestMethod — тип HTTP-запроса, используемый для запроса данных из ресурса (например, GET, POST и т. д.). Используется для потоков подтверждения владения. resourceRequestUri — URI, для этого маркера будет использоваться. Используется для потоков подтверждения владения.
CommonEndSessionRequest	CommonEndSessionRequest учетная запись — объект учетной записи, из который будет выходить из системы. Все маркеры, привязанные к этой учетной записи, будут сняты. postLogoutRedirectUri — URI для перехода к странице выхода. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. idTokenHint — маркер идентификатора, используемый B2C для проверки выхода при необходимости в политике состояние — значение, включенное в запрос к конечной точке выхода, которая будет возвращена в строке запроса при перенаправлении после выхода logoutHint — строка, указывающая учетную запись, которая выходит из системы, чтобы пропустить средство выбора учетной записи сервера при выходе extraQueryParameters — строка для сопоставления строк настраиваемых параметров запроса, добавленных в вызов /authorize
CommonRefreshTokenRequest	CommonRefreshTokenRequest области — массив областей, к к которые приложение запрашивает доступ. утверждения — запрос строковых утверждений, который будет добавлен ко всем вызовам /авторизовать и /token. центр — URL-адрес центра, служба маркеров безопасности (STS), из которой MSAL получит маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. refreshToken — маркер обновления, возвращенный из предыдущего запроса поставщику удостоверений. resourceRequestMethod — тип HTTP-запроса, используемый для запроса данных из ресурса (например, GET, POST и т. д.). Используется для потоков подтверждения владения. resourceRequestUri — URI, для этого маркера будет использоваться. Используется для потоков подтверждения владения. forceCache — принудительное использование MSAL для кэширования ответа потока маркера обновления при отсутствии учетной записи в кэше. Используется для сценариев миграции. tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token
CommonSilentFlowRequest	Параметры SilentFlow, передаваемые пользователем для автоматического получения учетных данных области — массив областей, к к которые приложение запрашивает доступ. утверждения — запрос строковых утверждений, который будет добавлен ко всем вызовам /авторизовать и /token. При включении автоматического запроса поиск кэша будет пропущен, а маркер будет обновлен. центр — URL-адрес центра, из которого приложение получает маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. учетная запись — сущность учетной записи для поиска учетных данных. forceRefresh — принудительно отправляет автоматические запросы на выполнение сетевых вызовов, если значение true. resourceRequestMethod — тип HTTP-запроса, используемый для запроса данных из ресурса (например, GET, POST и т. д.). Используется для потоков подтверждения владения. resourceRequestUri — URI, для этого маркера будет использоваться. Используется для потоков подтверждения владения. tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token
CredentialEntity	Тип кэша учетных данных
CredentialFilter	Учетные данные: <home_account_id*>-<environment-credential_type-client_id-realm>><><<*>-<target*-<scheme*>>
ExternalTokenResponse	Объект ответа, используемый для загрузки внешних маркеров в кэш. token_type. Указывает значение типа токена. Единственным типом, который поддерживает Azure AD, является носитель. область: области, для которыми действительна access_token. expires_in. Как долго маркер доступа действителен (в секундах). id_token: веб-токен JSON (JWT). Приложение может расшифровать сегменты этого маркера, чтобы запросить сведения о выполнившем вход пользователе. refresh_token: маркер обновления OAuth 2.0. Приложение может использовать этот маркер получения дополнительных маркеров доступа после истечения срока действия текущего маркера доступа. access_token: запрошенный маркер доступа. Приложение может использовать этот маркер для аутентификации в защищенном ресурсе, таком как веб-API. client_info: объект сведений о клиенте
IdTokenEntity	Тип кэша маркеров идентификатора
InProgressPerformanceEvent
LibraryStateObject	Тип, определяющий объект, закодированный и отправляемый в значении состояния. Содержит следующее: id — уникальный идентификатор для этого запроса ts — метка времени на время создания запроса. Используется для обеспечения неправильного вычисления срока действия маркера. platformState — строковое значение, отправленное из платформы.
LoggerOptions	Используйте это для настройки ведения журнала, которое выполняет MSAL, путем настройки параметров ведения журнала в объекте Configuration loggerCallback — обратный вызов для средства ведения журнала piiLoggingEnabled — задает, включена ли ведение журнала pii LogLevel — задает уровень, на котором выполняется ведение журнала. correlationId — задает идентификатор корреляции, напечатанный средство ведения журнала
NetworkRequestOptions	Параметры, разрешенные API-интерфейсами сетевого запроса.
NetworkResponse
OIDCOptions	Параметры режима протокола OIDC.
PerformanceCallbackFunction
PerformanceEvent	Измерение производительности, принятое библиотекой, включая метаданные о запросе и приложении.
PkceCodes	Тип PkceCodes описывает структуру объектов, содержащих проблемы кода PKCE и пары проверяющего объекта.
QueueMeasurement	Тип измерения очереди
RefreshTokenEntity	Тип кэша маркеров обновления
RequestStateObject	Тип, определяющий строковый и закодированный объект, отправленный службе в запросе авторизации.
RequestThumbprint	Тип, представляющий уникальный отпечаток запроса.
ServerAuthorizationTokenResponse	Десериализированный объект ответа из запроса кода авторизации сервера. token_type. Указывает значение типа токена. Может быть медведь или поп. область: области, для которыми действительна access_token. expires_in. Как долго маркер доступа действителен (в секундах). refresh_in. Длительность действия, которую следует продлить, независимо от истечения срока действия. ext_expires_in. Сколько времени маркер доступа действителен (в секундах), если сервер не отвечает. access_token: запрошенный маркер доступа. Приложение может использовать этот маркер для аутентификации в защищенном ресурсе, таком как веб-API. refresh_token: маркер обновления OAuth 2.0. Приложение может использовать этот маркер получения дополнительных маркеров доступа после истечения срока действия текущего маркера доступа. id_token: веб-токен JSON (JWT). Приложение может расшифровать сегменты этого маркера, чтобы запросить сведения о выполнившем вход пользователе. key_id: строка, которая однозначно идентифицирует открытый ключ, к которому привязан запрос. В случае ошибки: ошибка: строка кода ошибки, которая может использоваться для классификации типов ошибок, возникающих, и может использоваться для реагирования на ошибки. error_description. Определенное сообщение об ошибке, которое может помочь разработчику определить первопричину ошибки проверки подлинности. error_codes: список кодов ошибок, относящихся к stS, которые могут помочь в диагностике. метка времени: время возникновения ошибки. trace_id: уникальный идентификатор запроса, который может помочь в диагностике. correlation_id: уникальный идентификатор запроса, который может помочь в диагностике между компонентами. состояние: состояние ответа сетевого запроса
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache	Определяет, должны ли маркеры храниться в кэше или нет. Если задано значение false, маркеры по-прежнему могут быть приобретены и возвращены, но не будут кэшированы для последующего извлечения.
StringDict	тип Key-Value для поддержки queryParams, extraQueryParams и утверждений
SubMeasurement
SystemOptions	Используйте это для настройки сведений о продлении маркера в объекте Configuration tokenRenewalOffsetSeconds — задает окно смещения, необходимое для продления маркера до истечения срока действия.
TenantProfile	Сведения об учетной записи, которые зависят от клиентов одного пользователя
ThrottlingEntity
TokenClaims	Тип, описывающий утверждения маркера идентификатора, известные MSAL.
TokenKeys
AppTokenProviderParameters	Входной объект для расширяемости IAppTokenProvider. MSAL создаст этот объект, который можно использовать для создания AppTokenProviderResult. correlationId — идентификатор корреляции, связанный с запросом tenantId — идентификатор клиента, для которого должен быть предоставлен маркер. области — области, для которых должен быть предоставлен маркер. утверждения — любые дополнительные утверждения, которые маркер должен удовлетворять
AppTokenProviderResult	Выходной объект для расширяемости IAppTokenProvider. accessToken — фактический маркер доступа, как правило, в формате JWT, который удовлетворяет данным запроса AppTokenProviderParameters истекает срок действия Маркеров до истечения срока действия в секундах. Аналогично полю "expires_in" в ответе маркера AAD. refreshInSeconds — как долго маркер должен быть заранее обновлен. Аналогично полю "refresh_in" в ответе маркера AAD.
ClientAssertion	Учетные данные утверждения клиента для конфиденциальных клиентов
ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest	CommonClientCredentialRequest области — массив областей, к к которые приложение запрашивает доступ. центр — URL-адрес центра, служба маркеров безопасности (STS), из которой MSAL получит маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. skipCache — пропуск поиска кэша маркеров и принудительного запроса на получение нового маркера. По умолчанию false. preferredAzureRegionOptions — параметры предпочтительного региона Azure пользователя tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token
CommonDeviceCodeRequest	Параметры потока кода устройства Oauth2. области — массив областей, к к которые приложение запрашивает доступ. центр: — URL-адрес центра, служба маркеров безопасности (STS), из которой MSAL получит маркеры. Если центр задан в объекте клиентского приложения, это переопределит это значение. Переопределение значения приведет к тому, что проверка центра будет выполняться каждый раз. Если один и тот же центр будет использоваться для всех запросов, задайте для объекта приложения вместо запросов. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. deviceCodeCallback — обратный вызов, содержащий ответ кода устройства. Сообщение должно отображаться для конечного пользователя. Затем конечный пользователь может перейти к verification_uri, ввести user_code и входные учетные данные. отмена — логическое значение для отмены опроса конечной точки кода устройства. Хотя пользователь проходит проверку подлинности на отдельном устройстве, MSAL опрашивает конечную точку маркера службы маркеров безопасности за интервал, указанный в ответе кода устройства (обычно 15 минут). Чтобы остановить опрос и отменить запрос, задайте значение cancel=true. resourceRequestMethod — тип HTTP-запроса, используемый для запроса данных из ресурса (например, GET, POST и т. д.). Используется для потоков подтверждения владения. resourceRequestUri — URI, для этого маркера будет использоваться. Используется для потоков подтверждения владения. время ожидания — период ожидания в секундах, в течение которых пользователь явно настраивает для опроса конечной точки кода устройства. В конце этого периода; Если код устройства еще не истек; Опрос кода устройства останавливается и запрос отменен. Окно истечения срока действия кода устройства всегда будет иметь приоритет над этим заданным периодом. extraQueryParameters — строка на строку сопоставления настраиваемых параметров запроса, добавленных в строку запроса.
CommonOnBehalfOfRequest	области — массив областей, к к которые приложение запрашивает доступ. центр — URL-адрес центра, служба маркеров безопасности (STS), из которой MSAL получит маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. oboAssertion — маркер доступа, отправленный в API среднего уровня. Этот маркер должен иметь аудиторию приложения, выполняющего этот запрос OBO. skipCache — пропуск поиска кэша маркеров и принудительного запроса на получение нового маркера. По умолчанию false. tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token
CommonUsernamePasswordRequest	Параметры CommonUsernamePassword, переданные пользователем для получения учетных данных, примечание. Последняя версия OAuth 2.0 Security Best Current Practice запрещает предоставление пароля полностью. Этот поток добавляется для внутреннего тестирования. области — массив областей, к к которые приложение запрашивает доступ. утверждения — запрос строковых утверждений, который будет добавлен ко всем вызовам /авторизовать и /token. При включении автоматического запроса поиск кэша будет пропущен, а маркер будет обновлен. центр — URL-адрес центра, из которого приложение получает маркеры. correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии. имя пользователя — имя пользователя клиента password — учетные данные tokenQueryParameters — строка со строковой картой настраиваемых параметров запроса, добавленных в вызов /token
DeviceCodeResponse	Код устройства, возвращаемый конечной точкой кода устройства службы маркеров безопасности, содержащей сведения, необходимые для потока кода устройства. userCode: код, который пользователь должен предоставить при проверке подлинности в URI проверки deviceCode: код, который должен быть включен в запрос маркера доступа authenticationUri: URI, где пользователь может пройти проверку подлинности истекает срок действия кода устройства в секундах. интервал: интервал, в котором должна быть опрашивается служба STS сообщение: сообщение, которое должно отображаться пользователю
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

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

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

Функции

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)
buildClientInfo(string, (input: string) => string)	Функция для создания объекта сведений клиента из строки clientInfo сервера
buildClientInfoFromHomeAccountId(string)	Функция для создания объекта сведений клиента из кэшированных строк homeAccountId
buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)	Создание профиля клиента
createAuthError(string, string)
createCacheError(unknown)	Вспомогательные функции для упаковки ошибок браузера в объект CacheError
createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)	Создает элемент InteractionRequiredAuthError
createNetworkError(AuthError, number, Record<string, string>, Error)	Создает объект NetworkError для неудачного сетевого запроса
formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)	Возвращает идентификатор клиента из доступных утверждений маркера идентификатора для задания в качестве области учетных данных со следующим приоритетом: tid — если маркер получен из клиента AD Azure будет присутствовать tfp — если токен получен из современного TFP клиента B2C, должен присутствовать acr — если маркер получен из устаревшего ACR клиента B2C должен быть представлен в нижнем регистре, чтобы соответствовать требованиям сравнения с регистром в области
tenantIdMatchesHomeTenant(string, string)	Возвращает значение true, если идентификатор клиента соответствует части utid homeAccountId
updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)	Заменяет сведения об учетной записи, которые зависят от профиля клиента, полученного от утверждений маркера идентификатора, переданных с помощью сведений об учетной записи для конкретного клиента.

Переменные

AADAuthorityConstants	Строковые константы, связанные с центром AAD
AuthenticationScheme	Тип запроса проверки подлинности
AuthorityType	Типы центров, поддерживаемые MSAL.
AzureCloudInstance
CacheAccountType	Типы учетных записей в кэше
CacheOutcome	Указывает причину получения маркера доступа от поставщика удостоверений
CacheType	Объединение всех типов кэша
CcsCredentialType
ClaimsRequestKeys	Ключи запросов утверждений
CredentialType	Тип учетных данных, хранящийся в кэше
EncodingTypes
GrantType	разрешенные grant_type
HeaderNames	Имена заголовков запроса
HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType	Допустимые значения для response_type
PasswordGrantConstants	Параметры предоставления пароля
PersistentCacheKeys	Ключи постоянного кэша MSAL, которые остаются во время входа пользователя.
ProtocolMode	Режимы протокола, поддерживаемые MSAL.
ResponseMode	допустимые значения для response_mode
ServerResponseType	допустимые значения для типа ответа сервера
AuthErrorMessage	Класс AuthErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.
ClientAuthErrorMessage	Строковые константы, используемые кодами ошибок и сообщениями.
ClientConfigurationErrorMessage	Класс ClientConfigurationErrorMessage, содержащий строковые константы, используемые кодами ошибок и сообщениями.
CodeChallengeMethodValues	допустимые значения для codeVerifier
Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage	Необходимые ошибки взаимодействия, определенные пакетом SDK
OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue	Мы рассмотрели этот "перечисление" в запросе вместо строки, однако он выглядит так, как допустимый список значений запроса продолжал изменяться за последние пару лет. Существуют некоторые незадокументированные значения запроса для некоторых внутренних партнеров, поэтому выбор универсального типа string вместо перечисления
StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants	Константы, связанные с регулированием
version

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

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

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

Параметры

cacheStorage

CacheManager

authority

Authority

homeAccountId

string

base64Decode

(input: string) => string

correlationId

string

idTokenClaims

TokenClaims

clientInfo

string

environment

string

claimsTenantId

null | string

authCodePayload

AuthorizationCodePayload

nativeAccountId

string

logger

Logger

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

AccountEntity

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

Функция для создания объекта сведений клиента из строки clientInfo сервера

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

Параметры

rawClientInfo

string

base64Decode

(input: string) => string

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

ClientInfo

buildClientInfoFromHomeAccountId(string)

Функция для создания объекта сведений клиента из кэшированных строк homeAccountId

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Параметры

homeAccountId

string

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

ClientInfo

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

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

Параметры

authOptions

Partial<AuthorityOptions>

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

StaticAuthorityOptions

buildTenantProfile(string, string, string, TokenClaims)

Создание профиля клиента

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

Параметры

homeAccountId

string

Идентификатор домашней учетной записи для этого объекта учетной записи

localAccountId

string

Идентификатор локальной учетной записи для этого объекта учетной записи

tenantId

string

Полный идентификатор клиента или организации, к которому принадлежит эта учетная запись

idTokenClaims

TokenClaims

Утверждения из маркера идентификатора

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

TenantProfile

createAuthError(string, string)

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

Параметры

code

string

additionalMessage

string

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

AuthError

createCacheError(unknown)

Вспомогательные функции для упаковки ошибок браузера в объект CacheError

function createCacheError(e: unknown): CacheError

Параметры

e

unknown

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

CacheError

createClientAuthError(string, string)

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

Параметры

errorCode

string

additionalMessage

string

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

ClientAuthError

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Параметры

errorCode

string

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

ClientConfigurationError

createInteractionRequiredAuthError(string)

Создает элемент InteractionRequiredAuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Параметры

errorCode

string

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

InteractionRequiredAuthError

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

Создает объект NetworkError для неудачного сетевого запроса

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

Параметры

error

AuthError

Ошибка, возвращаемая вызывающей стороне

httpStatus

number

Код состояния сетевого запроса

responseHeaders

Record<string, string>

Заголовки ответа для сетевого запроса, если они доступны

additionalError

Error

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

NetworkError

Объект NetworkError

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Параметры

authorityUri

string

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

string

getRequestThumbprint(string, BaseAuthRequest, string)

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

Параметры

clientId

string

request

BaseAuthRequest

homeAccountId

string

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

RequestThumbprint

getTenantIdFromIdTokenClaims(TokenClaims)

Возвращает идентификатор клиента из доступных утверждений маркера идентификатора для задания в качестве области учетных данных со следующим приоритетом:

1. tid — если маркер получен из клиента AD Azure будет присутствовать
2. tfp — если токен получен из современного TFP клиента B2C, должен присутствовать
3. acr — если маркер получен из устаревшего ACR клиента B2C должен быть представлен в нижнем регистре, чтобы соответствовать требованиям сравнения с регистром в области

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

Параметры

idTokenClaims

TokenClaims

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

string | null

tenantIdMatchesHomeTenant(string, string)

Возвращает значение true, если идентификатор клиента соответствует части utid homeAccountId

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

Параметры

tenantId

string

homeAccountId

string

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

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Заменяет сведения об учетной записи, которые зависят от профиля клиента, полученного от утверждений маркера идентификатора, переданных с помощью сведений об учетной записи для конкретного клиента.

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

Параметры

baseAccountInfo

AccountInfo

tenantProfile

TenantProfile

idTokenClaims

TokenClaims

idTokenSecret

string

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

AccountInfo

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

AADAuthorityConstants

Строковые константы, связанные с центром AAD

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

Тип

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

AuthenticationScheme

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

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

Тип

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

AuthorityType

Типы центров, поддерживаемые MSAL.

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

Тип

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

AzureCloudInstance

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

Тип

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

CacheAccountType

Типы учетных записей в кэше

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

Тип

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

CacheOutcome

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

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

Тип

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

CacheType

Объединение всех типов кэша

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

Тип

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

CcsCredentialType

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

Тип

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

ClaimsRequestKeys

Ключи запросов утверждений

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

Тип

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

CredentialType

Тип учетных данных, хранящийся в кэше

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

Тип

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

EncodingTypes

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

Тип

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

GrantType

разрешенные grant_type

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

Тип

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

HeaderNames

Имена заголовков запроса

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

Тип

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

HttpMethod

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

Тип

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

HttpStatus

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

Тип

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

JsonWebTokenTypes

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

Тип

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

OAuthResponseType

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

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

Тип

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

PasswordGrantConstants

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

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

Тип

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

PersistentCacheKeys

Ключи постоянного кэша MSAL, которые остаются во время входа пользователя.

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

Тип

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

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

ServerResponseType

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

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

Use ResponseMode instead

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

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

Тип

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

CodeChallengeMethodValues

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

CodeChallengeMethodValues: { PLAIN: string, S256: string }

Тип

{ PLAIN: string, S256: string }

Constants

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

Тип

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

DEFAULT_CRYPTO_IMPLEMENTATION

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

Тип

ICrypto

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Тип

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

Тип

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

Тип

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

Тип

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

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

Тип

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

Тип

86400000

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 }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

Тип

INetworkModule

THE_FAMILY_ID

THE_FAMILY_ID: "1"

Тип

"1"

ThrottlingConstants

Константы, связанные с регулированием

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

Тип

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

version

version: "15.17.0"

Тип

"15.17.0"