Тип ресурса homeRealmDiscoveryPolicy

  • Статья

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Представляет политику для управления Microsoft Entra поведением проверки подлинности для федеративных пользователей, в частности для автоматического ускорения и ограничений проверки подлинности пользователей в федеративных доменах. Вы можете задать homeRealmDiscoveryPolicy для всех субъектов-служб в организации или для определенных субъектов-служб в вашей организации. Дополнительные сведения о сценарии и политике см. в статье Настройка Microsoft Entra поведения входа в приложение с помощью политики обнаружения домашней области, а также вход в Microsoft Entra ID использование электронной почты в качестве альтернативного идентификатора входа.

Наследует от stsPolicy.

Методы

Метод Возвращаемый тип Описание
Создание homeRealmDiscoveryPolicy homeRealmDiscoveryPolicy Создайте объект homeRealmDiscoveryPolicy.
Вернуться домойRealmDiscoveryPolicy homeRealmDiscoveryPolicy Чтение свойств и связей объекта homeRealmDiscoveryPolicy.
Перечисление типов ресурсов homeRealmDiscoveryPolicy homeRealmDiscoveryPolicy Чтение свойств и связей объектов homeRealmDiscoveryPolicies.
Обновление homeRealmDiscoveryPolicy Нет Обновите объект homeRealmDiscoveryPolicy.
Удаление homeRealmDiscoveryPolicy Нет Удалите объект homeRealmDiscoveryPolicy.
Список appliesTo Коллекция directoryObject Получите список объектов каталога, к которым применена эта политика.
Назначение типа ресурса homeRealmDiscoveryPolicy Нет Назначьте объект homeRealmDiscoveryPolicy объекту servicePrincipal .
Список назначенных homeRealmDiscoveryPolicy Коллекция homeRealmDiscoveryPolicy Перечисление объектов homeRealmDiscoveryPolicy, назначенных объекту servicePrincipal .
Удаление типа ресурса homeRealmDiscoveryPolicy Нет Удалите объект homeRealmDiscoveryPolicy из объекта servicePrincipal .

Свойства

Свойство Тип Описание
id String Уникальный идентификатор для этой политики. Только для чтения.
Определение Коллекция строк Коллекция строк, содержащая строку JSON, которая определяет правила и параметры для этой политики. Дополнительные сведения о схеме JSON для этого свойства см. в разделе Свойства определения политики обнаружения домашней области . Обязательный.
description String Описание этой политики.
displayName String Отображаемое имя для этой политики. Обязательно.
isOrganizationDefault Логический Если задано значение true, активирует эту политику. Для одного типа политик может быть много, но по умолчанию организации можно активировать только одну. Необязательно, значение по умолчанию — false.

Свойства определения политики обнаружения домашней области

Приведенные ниже свойства формируют объект JSON, представляющий политику времени существования маркера. Этот объект JSON должен быть преобразован в строку с кавычками, экранируемыми для вставки в свойство определения . Ниже приведен пример в формате JSON:

"definition": [
    "{
        \"HomeRealmDiscoveryPolicy\": {
          \"AccelerateToFederatedDomain\":true,
          \"AllowCloudPasswordValidation\": false,
          \"PreferredDomain\":\"federated.example.edu\",
          \"AlternateIdLogin\":{
            \"Enabled\":true
          }
        }
      }"
  ]
Свойство Тип Описание
УскорениеToFederatedDomain Логический Задайте значение true для автоматического ускорения (обход обнаружения домашней области). Если true в клиенте есть только один проверенный и федеративный домен, пользователи будут сразу же отправляться в федеративный поставщик удостоверений (например, ADFS) для входа. Если true в клиенте есть несколько проверенных доменов, необходимо указать PreferredDomain . Необязательный параметр.
AllowCloudPasswordValidation Логический Задайте значение , true чтобы разрешить приложению проходить проверку подлинности федеративного пользователя, предоставляя учетные данные пользователя или пароля непосредственно в конечную точку маркера Microsoft Entra. Работает только в том случае, если включена синхронизация хэша паролей. Необязательный параметр.
AlternateIdLogin Json Задайте значение , {\"Enabled\": true} чтобы разрешить Microsoft Entra вход с использованием электронной почты в качестве альтернативного идентификатора входа. Работает, только если isOrganizationDefault имеет значение true. Необязательный параметр.
PreferredDomain String Указывает домен для ускорения входа в систему. Его можно опустить, если у клиента есть только один федеративный домен. Если она опущена и имеется несколько проверенных федеративных доменов, эта политика не будет действовать. Требуется, если параметр AccelerateToFederatedDomain имеет значение true.

Связи

Связь Тип Описание
appliesTo Коллекция directoryObject Коллекция directoryObject , к которому применена эта политика. Только для чтения.

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "definition": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": true
}