メンバー グループを取得するGet member groups

名前空間: microsoft.graphNamespace: microsoft.graph

指定したユーザー、グループ、またはディレクトリ オブジェクトがメンバーであるすべてのグループを返します。この関数は、推移的です。Return all the groups that the specified user, group, or directory object is a member of. This function is transitive.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) GroupMember および GroupMember というすべてのユーザーと、すべてのユーザーの読み取り。 all、および all。すべてを読み取ります。すべてのユーザーを取得します。すべてのユーザーとグループを取得します。すべてのユーザーを取得します。User.ReadBasic.All and GroupMember.Read.All, User.Read.All and GroupMember.Read.All, User.ReadBasic.All and Group.Read.All, User.Read.All and Group.Read.All, Directory.Read.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication GroupMember および all を読み取ります。 all および all。 all を参照してください。 all を取得します。User.Read.All and GroupMember.Read.All, User.Read.All and Group.Read.All, Directory.Read.All

使用するアクセス許可の種類を決定するには、次のシナリオのガイダンスを使用します。Use the follow scenario guidance to help determine which permission types to use:

  • GroupMember またはすべてのアクセス許可を使用して、サインインしているユーザーのグループメンバーシップを取得しています。Use User.Read and GroupMember.Read.All or User.Read and Group.Read.All permissions to get group memberships for the signed-in user.
  • すべてのユーザーまたは GroupMember および GroupMember のすべてのアクセス許可を取得します。すべての権限を取得します。すべての権限を取得するには、すべての権限を取得します。すべての権限を取得するには、すべてのユーザーを参照します。Use User.ReadBasic.All and GroupMember.Read.All, User.Read.All and GroupMember.Read.All, User.ReadBasic.All and Group.Read.All or User.Read.All and Group.Read.All permissions to get group memberships for any user.
  • グループのグループメンバーシップを取得するには、GroupMember または all 権限を使用します。Use GroupMember.Read.All or Group.Read.All permission to get group memberships for a group.
  • ディレクトリオブジェクトのグループメンバーシップを取得するには、すべてのアクセス許可を使用します。Use Directory.Read.All permission to get group memberships for a directory object.

HTTP 要求HTTP request

POST /me/getMemberGroups
POST /users/{id | userPrincipalName}/getMemberGroups
POST /groups/{id}/getMemberGroups
POST /directoryObjects/{id}/getMemberGroups

要求ヘッダーRequest headers

名前Name Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type stringstring application/jsonapplication/json

要求本文Request body

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。In the request body, provide a JSON object with the following parameters.

パラメーターParameter Type 説明Description
securityEnabledOnlysecurityEnabledOnly BooleanBoolean エンティティがメンバーであるセキュリティ グループのみを返すように指定するには true、がメンバーであるすべてのグループとディレクトリ ロールを返すように指定するには false を設定します。:パラメーターが true の場合、関数はユーザーでのみ呼び出せます。true to specify that only security groups that the entity is a member of should be returned; false to specify that all groups and directory roles that the entity is a member of should be returned. Note: The function can only be called on a user if the parameter is true.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で文字列コレクション オブジェクトを返します。If successful, this method returns 200 OK response code and String collection object in the response body.

Example

要求Request
POST https://graph.microsoft.com/v1.0/directoryObjects/{object-id}/getMemberGroups
Content-type: application/json

{
  "securityEnabledOnly": true
}
応答Response

注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(Edm.String)",
    "value": [
        "fee2c45b-915a-4a64-b130-f4eb9e75525e",
        "4fe90ae7-065a-478b-9400-e0a0e1cbd540",
        "e0c3beaf-eeb4-43d8-abc5-94f037a65697"
    ]
}