グループの一覧表示List groups

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

Office 365 グループを含み、それに限定されない組織のすべてのグループを一覧表示します。List all the groups in an organization, including but not limited to Office 365 Groups.

この操作は既定で各グループのプロパティのサブセットのみを返します。This operation returns by default only a subset of the properties for each group. これらの既定のプロパティは、「プロパティ」セクションに記載されています。These default properties are noted in the Properties section. 既定で_返されない_プロパティを取得するには、グループに対して GET 操作を実行し、$select OData クエリ オプションでプロパティを指定します。To get properties that are not returned by default, do a GET operation for the group and specify the properties in a $select OData query option. hasMembersWithLicenseErrors プロパティは例外で、$select クエリでは返されません。The hasMembersWithLicenseErrors property is an exception and is not returned in the $select query.

アクセス許可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) Group.Read.All、Directory.Read.All、Group.ReadWrite.All、Directory.ReadWrite.All、Directory.AccessAsUser.AllGroup.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
ApplicationApplication Group.Read.All、Directory.Read.All、Group.ReadWrite.All、Directory.ReadWrite.AllGroup.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All

HTTP 要求HTTP request

GET /groups

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

Office 365 グループ (別名統合グループ) のみを一覧表示するには、groupTypes にフィルターを適用します。To list only Office 365 Groups (aka unified groups), apply a filter on groupTypes:

GET https://graph.microsoft.com/v1.0/groups?$filter=groupTypes/any(c:c+eq+'Unified')

OData クエリ オプション $orderby を使用して、以下の例のように、組織内のグループを displayName 値で並べ替えることができます。You can use the OData query option $orderby to sort groups in an organization by the displayName values, as shown in the following example:

GET https://graph.microsoft.com/v1.0/groups?$orderby=displayName

OData クエリ オプションの詳細については、「OData クエリ パラメーター」を参照してください。For more information on OData query options, see OData Query Parameters.

要求ヘッダーRequest headers

名前Name 種類Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で group オブジェクトのコレクションを返します。If successful, this method returns a 200 OK response code and collection of group objects in the response body. 応答には、各グループの既定のプロパティのみが含まれています。The response includes only the default properties of each group.

Example

例 1: グループ オブジェクトのリストを取得するExample 1: Return a list of group objects

要求Request

要求の例を次に示します。The following is an example of the request.

GET https://graph.microsoft.com/v1.0/groups

応答Response

応答の例を次に示します。The following is an example of the response.

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。Note: The response object shown here might be shortened for readability. 実際の呼び出しでは、各グループのすべての既定のプロパティが返されます。All the default properties are returned for each group in an actual call.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups",
    "value": [
        {
            "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
            "deletedDateTime": null,
            "classification": null,
            "createdDateTime": "2018-12-22T02:21:05Z",
            "creationOptions": [],
            "description": "Self help community for golf",
            "displayName": "Golf Assist",
            "groupTypes": [
                "Unified"
            ],
            "mail": "golfassist@contoso.com",
            "mailEnabled": true,
            "mailNickname": "golfassist",
            "onPremisesLastSyncDateTime": null,
            "onPremisesSecurityIdentifier": null,
            "onPremisesSyncEnabled": null,
            "preferredDataLocation": "CAN",
            "proxyAddresses": [
                "smtp:golfassist@contoso.onmicrosoft.com",
                "SMTP:golfassist@contoso.com"
            ],
            "renewedDateTime": "2018-12-22T02:21:05Z",
            "resourceBehaviorOptions": [],
            "resourceProvisioningOptions": [],
            "securityEnabled": false,
            "visibility": "Public",
            "onPremisesProvisioningErrors": []
        },
        {
            "id": "d7797254-3084-44d0-99c9-a3b5ab149538",
            "deletedDateTime": null,
            "classification": null,
            "createdDateTime": "2018-11-19T20:29:40Z",
            "creationOptions": [],
            "description": "Talk about golf",
            "displayName": "Golf Discussion",
            "groupTypes": [],
            "mail": "golftalk@contoso.com",
            "mailEnabled": true,
            "mailNickname": "golftalk",
            "onPremisesLastSyncDateTime": null,
            "onPremisesSecurityIdentifier": null,
            "onPremisesSyncEnabled": null,
            "preferredDataLocation": "CAN",
            "proxyAddresses": [
                "smtp:golftalk@contoso.onmicrosoft.com",
                "SMTP:golftalk@contoso.com"
            ],
            "renewedDateTime": "2018-11-19T20:29:40Z",
            "resourceBehaviorOptions": [],
            "resourceProvisioningOptions": [],
            "securityEnabled": false,
            "visibility": null,
            "onPremisesProvisioningErrors": []
        }
    ]
}

例 2: フィルター処理されたグループ オブジェクトのリストを返すExample 2: Return a filtered list of group objects

要求Request

この例では、$filter クエリ オプションを使用して、グループ ベースのライセンス割り当てによるライセンス エラーが発生したメンバーが含まれているグループを取得します。This example uses a $filter query option to get those groups that have members with license errors from their group-based license assignments. また、$select クエリ オプションも使用して、各グループの id プロパティと displayName プロパティのみを応答で取得します (その他の既定または既定以外のプロパティは取得しません)。It also uses a $select query option to get only the id and displayName properties of each group in the response, and not other default or non-default properties.

GET https://graph.microsoft.com/v1.0/groups?$filter=hasMembersWithLicenseErrors+eq+true&$select=id,displayName

応答Response

要求したプロパティのみを含む応答の例を次に示します。The following is an example of the response which includes only the requested properties.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(id,displayName)",
    "value": [
        {
            "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
            "displayName": "Library Assist"
        },
        {
            "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
            "displayName": "Golf Assist"
        }
    ]
}