homeRealmDiscoveryPolicy リソースの種類
名前空間: microsoft.graph
フェデレーション ユーザーのMicrosoft Entra認証動作を制御するポリシーを表します。特に、フェデレーション ドメインでの自動高速化とユーザー認証の制限についてです。 homeRealmDiscoveryPolicy は、organization内のすべてのサービス プリンシパル、またはorganization内の特定のサービス プリンシパルに対して設定できます。 シナリオとポリシーの詳細については、「ホーム領域検出ポリシーを使用してアプリケーションMicrosoft Entraサインイン動作を構成する」および「サインインして、代替ログイン ID として電子メールを使用するMicrosoft Entra IDする」を参照してください。
stsPolicy から継承します。
メソッド
メソッド | 戻り値の型 | 説明 |
---|---|---|
homeRealmDiscoveryPolicies を一覧表示する | homeRealmDiscoveryPolicy | homeRealmDiscoveryPolicies オブジェクトのプロパティとリレーションシップを読み取ります。 |
homeRealmDiscoveryPolicy を作成する | homeRealmDiscoveryPolicy | homeRealmDiscoveryPolicy オブジェクトを作成します。 |
HomeRealmDiscoveryPolicy を取得する | homeRealmDiscoveryPolicy | homeRealmDiscoveryPolicy オブジェクトのプロパティとリレーションシップを読み取ります。 |
homeRealmDiscoveryPolicy を更新する | なし | homeRealmDiscoveryPolicy オブジェクトを更新します。 |
homeRealmDiscoveryPolicy を削除する | なし | homeRealmDiscoveryPolicy オブジェクトを削除します。 |
appliesTo の一覧 | directoryObject コレクション | このポリシーが適用されている directoryObjects の一覧を取得します。 |
プロパティ
プロパティ | 型 | 説明 |
---|---|---|
definition | String collection | このポリシーの規則と設定を定義する JSON 文字列を含む文字列コレクション。 このプロパティの JSON スキーマの詳細については、「 ホーム 領域検出ポリシー定義 のプロパティ」を参照してください。 必須です。 |
説明 | String | このポリシーの説明。 |
displayName | String | このポリシーの表示名。 必須。 |
id | String | このポリシーの一意識別子。 読み取り専用。 |
isOrganizationDefault | ブール型 | に設定すると true 、このポリシーがアクティブになります。 同じポリシーの種類に対して多数のポリシーを使用できますが、organizationの既定値としてアクティブ化できるのは 1 つだけです。 省略可能です。既定値は です false 。 |
ホーム領域検出ポリシー定義のプロパティ
次のプロパティは、トークンの有効期間ポリシーを表す JSON オブジェクトを形成します。 この JSON オブジェクトは、定義プロパティに挿入するには、引用符がエスケープされた文字列に変換する必要があります。 JSON 形式の例を次に示します。
"definition": [
"{
\"HomeRealmDiscoveryPolicy\": {
\"AccelerateToFederatedDomain\":true,
\"AllowCloudPasswordValidation\": false,
\"PreferredDomain\":\"federated.example.edu\",
\"AlternateIdLogin\":{
\"Enabled\":true
}
}
}"
]
プロパティ | 型 | 説明 |
---|---|---|
AccelerateToFederatedDomain | ブール型 | 自動高速化の場合は を に true 設定します (ホーム領域の検出をバイパスします)。 テナントに検証済みおよびフェデレーション ドメインが 1 つしかない場合 true 、ユーザーはサインインのためにフェデレーション 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
}
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示