グループの一覧表示List groups

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

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

この操作は既定で各グループで頻繁に使用されるプロパティのサブセットのみを返します。This operation returns by default only a subset of the more commonly used 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. を参照してください。See an example.

例外は hasMembersWithLicenseErrors プロパティです。An exception is the hasMembersWithLicenseErrors property. このプロパティの使用方法のを参照してください。See an example of how to use this property.

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

要求 1Request 1

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

GET https://graph.microsoft.com/beta/groups

応答 1Response 1

応答の例を次に示します。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/beta/$metadata#groups",
    "value": [
         {
            "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
            "deletedDateTime": null,
            "classification": null,
            "createdDateTime": "2018-12-22T02:21:05Z",
            "description": "Self help community for golf",
            "displayName": "Golf Assist",
            "expirationDateTime": null,
            "groupTypes": [
                "Unified"
            ],
            "mail": "golfassist@contoso.com",
            "mailEnabled": true,
            "mailNickname": "golfassist",
            "membershipRule": null,
            "membershipRuleProcessingState": null,
            "onPremisesLastSyncDateTime": null,
            "onPremisesSecurityIdentifier": null,
            "onPremisesSyncEnabled": null,
            "preferredDataLocation": "CAN",
            "preferredLanguage": null,
            "proxyAddresses": [
                "smtp:golfassist@contoso.onmicrosoft.com",
                "SMTP:golfassist@contoso.com"
            ],
            "renewedDateTime": "2018-12-22T02:21:05Z",
            "resourceBehaviorOptions": [],
            "resourceProvisioningOptions": [],
            "securityEnabled": false,
            "theme": null,
            "visibility": "Public",
            "onPremisesProvisioningErrors": []
        },
        {
            "id": "d7797254-3084-44d0-99c9-a3b5ab149538",
            "deletedDateTime": null,
            "classification": null,
            "createdDateTime": "2018-11-19T20:29:40Z",
            "description": "Talk about golf",
            "displayName": "Golf Discussion",
            "expirationDateTime": null,
            "groupTypes": [],
            "mail": "golftalk@contoso.com",
            "mailEnabled": true,
            "mailNickname": "golftalk",
            "membershipRule": null,
            "membershipRuleProcessingState": null,
            "onPremisesLastSyncDateTime": null,
            "onPremisesSecurityIdentifier": null,
            "onPremisesSyncEnabled": null,
            "preferredDataLocation": "CAN",
            "preferredLanguage": null,
            "proxyAddresses": [
                "smtp:golftalk@contoso.onmicrosoft.com",
                "SMTP:golftalk@contoso.com"
            ],
            "renewedDateTime": "2018-11-19T20:29:40Z",
            "resourceBehaviorOptions": [],
            "resourceProvisioningOptions": [],
            "securityEnabled": false,
            "theme": null,
            "visibility": null,
            "onPremisesProvisioningErrors": []
        }
    ]
}

SDK サンプル コードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var groups = await graphClient.Groups
    .Request()
    .GetAsync();

SDK をプロジェクトに追加し、 authproviderインスタンスを作成する方法の詳細については、 sdk のドキュメントを参照してください。Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

要求 2Request 2

この例では、$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/beta/groups?$filter=hasMembersWithLicenseErrors+eq+true&$select=id,displayName

応答 2Response 2

要求したプロパティのみを含む応答の例を次に示します。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/beta/$metadata#groups(id,displayName)",
    "value": [
        {
            "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
            "displayName": "Library Assist"
        },
        {
            "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
            "displayName": "Golf Assist"
        }
    ]
}

SDK サンプル コードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var groups = await graphClient.Groups
    .Request()
    .Filter("hasMembersWithLicenseErrors+eq+true,")
    .Select( e => new {
             e.Id,
             e.DisplayName 
             })
    .GetAsync();

SDK をプロジェクトに追加し、 authproviderインスタンスを作成する方法の詳細については、 sdk のドキュメントを参照してください。Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.