ユーザーのメンバーシップを一覧表示する (直接および推移的)

  • [アーティクル]

名前空間: microsoft.graph

直接または推移的なメンバーシップを使用して、ユーザーがメンバーになっている グループ、 ディレクトリ ロール、 および管理単位 を取得します。

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

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

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) User.Read Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、GroupMember.Read.All、User.Read.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

重要

ロール割り当て可能なグループにメンバーを追加するには、呼び出し元のユーザーにも RoleManagement.ReadWrite.Directory アクセス許可を割り当てる必要があります。

アプリケーションが directoryObject 型コレクションを返すリレーションシップを照会する場合、特定の派生型 (デバイスなど) を読み取るアクセス許可がない場合、その型のメンバーは返されますが、情報は限られています。 この動作により、アプリケーションはディレクトリのセットに依存するのではなく、必要な最小限の特権のアクセス許可を要求できます 。*アクセス 許可。 詳細については、「アクセスできないメンバー オブジェクトについて、限定された情報が返される」を参照してください。

HTTP 要求

GET /me/transitiveMemberOf
GET /users/{id | userPrincipalName}/transitiveMemberOf

オプションのクエリ パラメーター

このメソッドは、応答をカスタマイズするための$select、$search、および$countを含むOData クエリ パラメーターをサポートします。 OData キャストも有効になっています。たとえば、グループ内の推移的なメンバーシップのみを取得するためにキャストできます。 displayNameプロパティで$searchを使用できます。 既定のページ サイズと最大ページ サイズはそれぞれ 100 オブジェクトと 999 オブジェクトです。

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
ConsistencyLevel 最終的。 このヘッダーおよび$countは、$search、$filter、$orderby、または OData キャスト クエリ パラメーターを使用する場合に必要です。 最新の状態に更新されていない可能性があるインデックスを使用しています。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で directoryObject オブジェクトのコレクションを返します。

例

例 1: ユーザーがメンバーであるグループ、ディレクトリ ロール、および管理単位を取得する

要求

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

GET https://graph.microsoft.com/v1.0/users/6e7b768e-07e2-4810-8459-485f84f8f204/transitiveMemberOf

応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
  "value":[
    {
      "@odata.type":"#microsoft.graph.group",
      "displayName":"All_Contoso_Licensing",
      "mailEnabled":true,
      "mailNickname":"ContosoMailNickName",
      "securityEnabled":true
    }
  ]
}

例 2: グループ、ディレクトリ ロール、および管理単位の推移的なメンバーシップの数のみを取得する

要求

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

GET https://graph.microsoft.com/v1.0/users/{id}/transitiveMemberOf/$count
ConsistencyLevel: eventual

応答

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

HTTP/1.1 200 OK
Content-type: text/plain

893

例 3: OData キャストを使用して、グループ内の推移的なメンバーシップ数のみを取得する

要求

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

GET https://graph.microsoft.com/v1.0/users/{id}/transitiveMemberOf/microsoft.graph.group/$count
ConsistencyLevel: eventual

応答

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

HTTP/1.1 200 OK
Content-type: text/plain

588

例 4: $searchキャストと OData キャストを使用して、返されたオブジェクトの数を含む文字 'tier' を含む表示名を持つグループの推移的なメンバーシップを取得する

要求

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

GET https://graph.microsoft.com/v1.0/users/{id}/transitiveMemberOf/microsoft.graph.group?$count=true&$orderby=displayName&$search="displayName:tier"&$select=displayName,id
ConsistencyLevel: eventual

応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups(displayName,id)",
  "@odata.count":7,
  "value":[
    {
      "displayName":"Contoso-tier Query Notification",
      "id":"11111111-2222-3333-4444-555555555555"
    }
  ]
}

例 5: $filterキャストと OData キャストを使用して、返されたオブジェクトの数を含む 'a' で始まる表示名を持つグループの推移的なメンバーシップを取得する

要求

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

GET https://graph.microsoft.com/v1.0/users/{id}/transitiveMemberOf/microsoft.graph.group?$count=true&$orderby=displayName&$filter=startswith(displayName, 'a')
ConsistencyLevel: eventual

応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups",
  "@odata.count":76,
  "value":[
    {
      "displayName":"AAD Contoso Users",
      "mail":"AADContoso_Users@contoso.com",
      "mailEnabled":true,
      "mailNickname":"AADContoso_Users",
      "securityEnabled":true
    }
  ]
}