homeRealmDiscoveryPolicy リソースの種類

[アーティクル]
07/16/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

フェデレーションユーザーの Microsoft Entra 認証動作を制御するポリシーを表します。特に、フェデレーションドメインでの自動設定とユーザー認証の制限に関しては。 homeRealmDiscoveryPolicy は、組織内のすべてのサービスプリンシパル、または組織内の特定のサービスプリンシパルに対して設定できます。シナリオとポリシーの詳細については、「 Home Realm Discovery ポリシーを使用してアプリケーションの Microsoft Entra サインイン動作を構成する」および「代替ログイン ID として電子メールを使用して Microsoft Entra ID にサインインする」を参照してください。

stsPolicy から継承します。

メソッド

メソッド	戻り値の型	説明
List	homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicies オブジェクトのプロパティとリレーションシップを読み取ります。
Create	homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy オブジェクトを作成します。
Get	homeRealmDiscoveryPolicy	homeRealmDiscoveryPolicy オブジェクトのプロパティとリレーションシップを読み取ります。
Update	なし	homeRealmDiscoveryPolicy オブジェクトを更新します。
Delete	なし	homeRealmDiscoveryPolicy オブジェクトを削除します。
一覧表示の適用対象	directoryObject コレクション	このポリシーが適用されている directoryObjects の一覧を取得します。
サービスプリンシパルに割り当てる	なし	homeRealmDiscoveryPolicy オブジェクトを servicePrincipal オブジェクトに割り当てます。
サービスプリンシパルに割り当てられた一覧	homeRealmDiscoveryPolicy コレクション	servicePrincipal オブジェクトに割り当てられている homeRealmDiscoveryPolicy オブジェクトを一覧表示します。
サービスプリンシパルからの割り当てを解除する	なし	servicePrincipal オブジェクトから homeRealmDiscoveryPolicy オブジェクトを削除します。

プロパティ

プロパティ	型	説明
id	String	このポリシーの一意識別子。読み取り専用です。
definition	String collection	このポリシーの規則と設定を定義する JSON 文字列を含む文字列コレクション。このプロパティの JSON スキーマの詳細については、「ホーム領域検出ポリシー定義のプロパティ」を参照してください。必須です。
説明	String	このポリシーの説明。
displayName	String	このポリシーの表示名。必須です。
isOrganizationDefault	ブール型	`true`に設定されている場合は、このポリシーをアクティブにします。同じポリシーの種類に対して多数のポリシーを使用できますが、組織の既定としてアクティブ化できるのは 1 つだけです。省略可能です。既定値は `false`。

ホーム領域検出ポリシー定義のプロパティ

次のオブジェクトは、トークンの有効期間ポリシー定義の JSON オブジェクトを形成するプロパティを示しています。この JSON オブジェクトは、次の例に示すように 、引用符がエスケープされた文字列に変換 して 、定義 プロパティに挿入する必要があります。

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

プロパティ	型	説明
AccelerateToFederatedDomain	ブール型	自動設定の `true` に設定します (ホーム領域検出をバイパスします)。 `true`し、テナントに検証済みおよびフェデレーションドメインが 1 つだけある場合、ユーザーはサインインのためにフェデレーション ID プロバイダー (ADFS など) に直接移動します。 `true`し、テナントに複数の検証済みドメインがある場合は、PreferredDomain を指定する必要があります。省略可能。
AllowCloudPasswordValidation	ブール型	`true` に設定すると、アプリケーションは Microsoft Entra トークンエンドポイントに直接ユーザー名/パスワード資格情報を提示してフェデレーションユーザーを認証できます。パスワードハッシュ同期が有効になっている場合にのみ機能します。省略可能。
AlternateIdLogin	Json	[ `{\"Enabled\": true}` ] に設定すると、代替ログイン ID として電子メールを使用した Microsoft Entra サインインが許可されます。 IsOrganizationDefault が `true` に設定されている場合にのみ機能します。省略可能。
PreferredDomain	String	サインインを高速化するドメインを指定します。テナントにフェデレーションドメインが 1 つしかない場合は省略できます。省略され、複数の検証済みフェデレーションドメインがある場合、このポリシーは無効です。 AccelerateToFederatedDomain が`true`されている場合は必須です。

リレーションシップ

リレーションシップ	型	説明
appliesTo	directoryObject コレクション	このポリシーが適用されている directoryObject コレクション。読み取り専用です。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

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

次の方法で共有