homeRealmDiscoveryPolicy リソースの種類

[アーティクル]
04/18/2024

名前空間: microsoft.graph

重要

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

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

stsPolicy から継承します。

メソッド

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

プロパティ

プロパティ	型	説明
id	String	このポリシーの一意識別子。読み取り専用です。
definition	String collection	このポリシーの規則と設定を定義する JSON 文字列を含む文字列コレクション。このプロパティの JSON スキーマの詳細については、「ホーム領域検出ポリシー定義のプロパティ」を参照してください。必須です。
説明	String	このポリシーの説明。
displayName	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
}