homeRealmDiscoveryPolicy 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示用于控制联合用户的Microsoft Entra 身份验证行为的策略，尤其是针对联合域中的自动注册和用户身份验证限制。 可以为组织中的所有服务主体或组织中的特定服务主体设置 homeRealmDiscoveryPolicy。 有关更多方案和策略详细信息，请参阅 使用主领域发现策略为应用程序配置 Microsoft Entra 登录行为 和 使用电子邮件作为备用登录 ID Microsoft Entra ID 登录。

继承自 stsPolicy。

方法

方法	返回类型	Description
List	homeRealmDiscoveryPolicy	读取 homeRealmDiscoveryPolicies 对象的属性和关系。
创建	homeRealmDiscoveryPolicy	创建 homeRealmDiscoveryPolicy 对象。
Get	homeRealmDiscoveryPolicy	读取 homeRealmDiscoveryPolicy 对象的属性和关系。
更新	无	更新 homeRealmDiscoveryPolicy 对象。
删除	None	删除 homeRealmDiscoveryPolicy 对象。
列表适用于	directoryObject collection	获取已应用此策略的 directoryObject 列表。
分配到服务主体	None	将 homeRealmDiscoveryPolicy 对象分配给 servicePrincipal 对象。
分配给服务主体的列表	homeRealmDiscoveryPolicy 集合	列出分配给 servicePrincipal 对象的 homeRealmDiscoveryPolicy 对象。
取消从服务主体分配	None	从 servicePrincipal 对象中删除 homeRealmDiscoveryPolicy 对象。

属性

属性	类型	说明
id	String	此策略的唯一标识符。 此为只读属性。
定义	字符串集合	一个字符串集合，其中包含定义此策略的规则和设置的 JSON 字符串。 有关此属性的 JSON 架构的详细信息，请参阅 主领域发现策略定义的属性。 必需。
description	String	此策略的说明。
displayName	String	此策略的显示名称。 必填。
isOrganizationDefault	布尔值	如果设置为 true，则激活此策略。 同一策略类型可以有多个策略，但只有一种策略可以激活为组织默认策略。 可选，默认值为 false。

主领域发现策略定义的属性

以下对象显示了构成令牌生存期策略定义的 JSON 对象的属性。 此 JSON 对象必须 转换为带转义引号的字符串 ，才能插入 到定义 属性中，如以下示例所示。

"definition": [
    "{
        \"HomeRealmDiscoveryPolicy\": {
          \"AccelerateToFederatedDomain\":true,
          \"AllowCloudPasswordValidation\": false,
          \"PreferredDomain\":\"federated.example.edu\",
          \"AlternateIdLogin\":{
            \"Enabled\":true
          }
        }
      }"
  ]

属性	类型	说明
AccelerateToFederatedDomain	布尔值	true对于自动 (绕过主领域发现) ，请将 设置为 。 如果 true 租户中只有一个经过验证的联合域，则用户将直接转到联合标识提供者 (（例如 ADFS) ）进行登录。 如果 true 租户中有多个已验证域，则必须指定 PreferredDomain 。 可选。
AllowCloudPasswordValidation	布尔值	设置为 以 true 允许应用程序通过直接向 Microsoft Entra 令牌终结点提供用户名/密码凭据来对联合用户进行身份验证。 仅当启用了密码哈希同步时有效。 可选。
AlternateIdLogin	Json	{\"Enabled\": true}设置为 以允许Microsoft Entra 使用电子邮件作为备用登录 ID 登录。 仅当 IsOrganizationDefault 设置为 true时有效。 可选。
PreferredDomain	String	指定要加速登录的域。 如果租户只有一个联合域，则可以省略它。 如果省略它，并且有多个已验证的联合域，则此策略无效。 如果 AccelerateToFederatedDomain 为 ，则 true为 必需。

关系

关系	类型	说明
appliesTo	directoryObject collection	已应用此策略的 directoryObject 集合。 只读。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

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