group: evaluateDynamicMembership

  • [アーティクル]

名前空間: microsoft.graph

重要

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

ユーザーまたはデバイスが動的グループのメンバーであるかどうかを評価します。 メンバーシップ ルールは、評価で使用されたその他の詳細と共に返されます。 この操作は、次の方法で完了できます。

  • ユーザーまたはデバイスが指定された動的グループのメンバーであるかどうかを評価します。
  • ユーザーまたはデバイスの ID とメンバーシップ ルールに基づいて、ユーザーまたはデバイスが動的グループのメンバーであるかどうかを評価します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

次の表は、サポートされている各リソースの種類でこの API を呼び出すために必要な最小特権のアクセス許可またはアクセス許可を示しています。 ベスト プラクティスに従って、最小限の特権のアクセス許可を要求します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

メンバー ID とグループ ID を使用して動的メンバーシップを評価する

サポートされているリソース 委任 (職場または学校のアカウント) 委任 (個人用 Microsoft アカウント) アプリケーション
device Group.Read.All と Device.Read.All サポートされていません。 サポートされていません。
user Group.Read.All と User.Read.All サポートされていません。 サポートされていません。

メンバー ID とメンバーシップ ルールを使用して動的メンバーシップを評価する

サポートされているリソース 委任 (職場または学校のアカウント) 委任 (個人用 Microsoft アカウント) アプリケーション
device Device.Read.All サポートされていません。 サポートされていません。
user User.Read.All サポートされていません。 サポートされていません。

HTTP 要求

POST /groups/{id}/evaluateDynamicMembership
POST /groups/evaluateDynamicMembership

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-type application/json

要求本文

要求本文で、必要なプロパティを指定します。

次の表に、グループ メンバーシップを評価するときに必要なプロパティを示します。

パラメーター 型 説明
memberId String collection memberId は、評価するユーザーまたはデバイスのオブジェクト ID です。
membershipRule String collection メンバーシップの評価に使用されるルール。 このプロパティが指定されていない場合、既存のグループのルールが評価されます。 このプロパティが指定されている場合、ユーザーまたはデバイスは、同じ規則を持つグループ内のメンバーシップの可能性について評価されます。 詳細については、「Microsoft Entra IDのグループの動的メンバーシップルール」を参照してください。

応答

成功した場合、このメソッドは 200 OK 応答コードと evaluateDynamicMembershipResult オブジェクトを 返します。

例

例 1: ユーザーまたはデバイスが既存のグループのメンバーであるかどうかを評価する

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/groups/{id}/evaluateDynamicMembership
Content-type: application/json

{
  "memberId": "319b41e8-d9e4-42f8-bdc9-741113f48b33"
}

応答

次の例は応答を示しています。

HTTP/1.1 200 OK
Content-type: application/json

{
  "membershipRule": "(user.displayName -startsWith \"EndTestUser\")",
  "membershipRuleEvaluationResult": true,
  "membershipRuleEvaluationDetails": {
    "expressionResult": true,
    "expression": "user.displayName -startsWith \"EndTestUser\"",
    "propertyToEvaluate": {
      "propertyName": "displayName",
      "propertyValue": "EndTestUser001"
    }
  }
}

例 2: ユーザーまたはデバイスがメンバーシップ規則に基づいてグループのメンバーになるかどうかを評価する

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/groups/evaluateDynamicMembership
Content-type: application/json

{
  "memberId": "319b41e8-d9e4-42f8-bdc9-741113f48b33",
  "membershipRule": "(user.displayName -startsWith \"EndTestUser\")"
}

応答

次の例は応答を示しています。

HTTP/1.1 200 OK
Content-type: application/json

{
  "membershipRule": "(user.displayName -startsWith \"EndTestUser\")",
  "membershipRuleEvaluationResult": true,
  "membershipRuleEvaluationDetails": {
    "expressionResult": true,
    "expression": "user.displayName -startsWith \"EndTestUser\"",
    "propertyToEvaluate": {
      "propertyName": "displayName",
      "propertyValue": "EndTestUser001"
    }
  }
}