名前空間: microsoft.graph
フェデレーション ユーザーの 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 オブジェクトを削除します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| definition | String collection | このポリシーの規則と設定を定義する JSON 文字列を含む文字列コレクション。 このプロパティの JSON スキーマの詳細については、「 ホーム領域検出ポリシー定義のプロパティ」を参照してください。 必須です。 |
| 説明 | String | このポリシーの説明。 |
| displayName | String | このポリシーの表示名。 必須。 |
| id | 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
}