Поделиться через

Справочник по API на стороне сервера (MSA) учетной записи Майкрософт

Учетные записи Майкрософт (MSA) — это веб-служба единого входа, которая позволяет пользователям входить на веб-сайты, приложения и службы с помощью одного набора учетных данных. API на стороне сервера (MSA) учетной записи Майкрософт предоставляет ряд параметров, которые можно использовать для настройки процесса проверки подлинности и улучшения взаимодействия с пользователем.

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

API на стороне сервера MSA

Они передаются login.microsoftonline.com в параметры URL-адреса или login.live.com в формате login.microsoftonline.com?parametername=value.

Параметр Значение Примечания.
ImplicitAssociate 0/1 Если задано значение 1, учетная запись Майкрософт (MSA), которую пользователь использует для входа, автоматически связана с приложением в Windows, не требуя подтверждения пользователя.
Примечание. Это не включает единый вход для пользователя.
LoginHint имя пользователя Предварительно заполняет имя пользователя во время входа, если только не указано (например, с помощью маркера обновления). При необходимости пользователи могут изменить это предварительно заполненное имя пользователя.
cobrandid guid cobranding Этот параметр применяет cobranding к пользовательскому интерфейсу входа. Cobranding позволяет настраивать такие элементы, как логотип приложения, фоновое изображение, текст субтитров, текст описания и цвета кнопки. Если вы интегрируете приложение с учетной записью Майкрософт и хотите настроить экран входа, обратитесь в службу поддержки Майкрософт.
client_flight Строка client_flight — это парольный параметр, возвращаемый приложению после завершения процесса входа. Значение этого параметра регистрируется в потоке телеметрии и используется приложениями для объединения запросов проверки подлинности. Это может быть полезно для сопоставления запросов на вход, даже если у всех приложений есть доступ к этому потоку телеметрии. Такие приложения, как Office Union, Teams и другие, являются заметными пользователями этого параметра.
lw 0/1 Примечание. Эта функция устарела. Включает упрощенную регистрацию. Если это разрешено, пользователи не должны вводить свое имя, фамилию, страну или регион и дату рождения, если не требуется в соответствии с законами, применимыми к региону пользователя.
fl phone2,
email,
wld,
wld2,
easi,
easi2		 Примечание. Эта функция устарела. Этот параметр управляет параметрами имени пользователя, предоставленными во время процесса регистрации:
phone — ограничивает имя пользователя номером телефона,
phone2 — по умолчанию используется номер телефона, но позволяет использовать другие параметры.
email — ограничивает имя пользователя электронной почтой (Outlook или EASI),
wld — ограничивает имя пользователя в Outlook,
wld2 — по умолчанию для Outlook, но разрешает другие варианты, включая телефон,
easi — ограничивает имя пользователя в УПРОЩЕНИИ,
easi2 — По умолчанию используется функция EASI, но позволяет использовать другие параметры, включая телефон.
nopa 0/1/2 Примечание. Эта функция устарела. Включает регистрацию без пароля. Значение 1 разрешает регистрацию без пароля, но применяет создание пароля через 30 дней. Значение 2 разрешает регистрацию без пароля на неопределенный срок. Чтобы использовать значение 2, приложения необходимо добавить в список разрешений с помощью ручного процесса.
coa 0/1 Примечание. Эта функция устарела. Включает вход без пароля, отправив код на номер телефона пользователя. Чтобы использовать значение 1, приложения необходимо добавить в список разрешений с помощью ручного процесса.
signup 0/1 Запустите поток проверки подлинности на странице "Создание учетной записи ", а не на странице входа .
fluent 0/1 Примечание. Эта функция устарела. Включает новый внешний вид Fluent и чувствует себя для потока входа. Чтобы использовать значение 1, приложения необходимо добавить в список разрешений с помощью ручного процесса.
api-version “”/”2.0” Если задано 2.0значение , этот параметр позволяет клиенту указать идентификатор приложения, отличный от идентификатора приложения, зарегистрированного в вызывающем приложении Windows, учитывая, что указанный идентификатор приложения настроен для разрешения этого.
Clientid/client_id app ID Идентификатор приложения для приложения, вызывающего поток проверки подлинности.
Client_uiflow new_account Позволяет приложениям добавлять новую учетную запись без вызова AccountsSettingsPane. Требуется также передать тип запроса ForceAuthentication. Требуется также передать тип запроса ForceAuthentication .

Параметры маркера авторизации MSA

Параметр Значение Примечания.
scope Строка Определяет степень разрешений, запрошенных клиентом в конечных точках авторизации и маркера.
claims Строка Указывает необязательные утверждения, запрашиваемые клиентским приложением.
response_type Строка Указывает значение типа ответа OAuth 2.0, которое определяет поток процесса авторизации, включая параметры, возвращаемые из соответствующих конечных точек.
phone Строка Задает разделенный запятыми список отформатированных номеров телефонов, связанных с хост-устройством.
qrcode_uri Строка В запросах на создание QR-кода для передачи прошедшего проверку подлинности сеанса этот URL-адрес внедряется в QR-код.
Ttv 1 / 2 Подлежит уточнению
qrcode_state Строка В запросах на создание QR-кода этот параметр состояния включается в URL-адрес, отображаемый в QR-коде.
Child_client_id Строка Идентификатор дочернего клиентского приложения в потоке двойного брокера.
child_redirect_uri Строка URI перенаправления дочернего клиентского приложения, используемого в потоке двойного брокера.
safe_rollout Строка Параметр, используемый для указания плана безопасного развертывания, примененного к запросу. Полезно, когда владелец приложения развертывает изменение конфигурации приложения и хочет, чтобы изменения применялись постепенно для целей развертывания безопасности.
additional_scope Строка Задает дополнительную область, чтобы служба проверки подлинности может собирать дополнительное согласие в одном запросе. Таким образом, клиентское приложение может избежать прерывания согласия при запросе другой области в будущем.
x-client-info 1/0 Маркер Client_info возвращается при значении 1.0.
challenge Строка Изначально приложение ресурсов перенаправит клиентское приложение на сервер MSA без каких-либо изменений.
max_age Целое Максимальный возраст проверки подлинности. Указывает допустимое время, прошедшее в секундах с момента последнего проверки подлинности конечным пользователем в MSA.
mfa_max_age Целое Указывает допустимое время в секундах с момента последнего прохождения пользователем многофакторной проверки подлинности в MSA.
acr_values Строка Запрошенные значения ссылок на класс контекста проверки подлинности. Строка, разделенная пробелами, указывающая значения acr, которые запрашивается сервером авторизации для обработки этого запроса проверки подлинности, со значениями, отображаемыми в порядке предпочтения. Класс контекста проверки подлинности, удовлетворенный выполненной проверкой подлинности, возвращается в качестве значения утверждения acr.
redirect_uri Строка URI перенаправления, в который отправляется ответ. Этот универсальный код ресурса (URI) должен точно соответствовать одному из значений URI перенаправления для предварительной регистрации клиента в MSA.
state Строка Непрозрачное значение, используемое для поддержания состояния между запросом и обратным вызовом.
oauth2_response 1 Если равно 1, это означает, что ответ ws-trust должен соответствовать формату ответа OAuth.

См. также