グループを取得するGet group

重要

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.

group オブジェクトのプロパティとリレーションシップを取得します。Get the properties and relationships of a group object.

プロパティ」セクションに記載されているように、この操作は既定ですべての使用できるプロパティのサブセットのみを返します。This operation returns by default only a subset of all the available properties, as noted in the Properties section.

既定では_返されない_プロパティを取得するには、$select OData クエリ オプションでそれらを指定します。To get properties that are not returned by default, specify them in a $select OData query option. $selectを参照してください。See an example of $select. 例外は hasMembersWithLicenseErrors プロパティです。An exception is the hasMembersWithLicenseErrors property. このプロパティの使用方法のを参照してください。See an example of how to use this property.

グループ リソースは拡張機能をサポートしているため、GET 操作を使用して、グループ インスタンスでカスタム プロパティと拡張機能データを取得することもできます。Since the group resource supports extensions, you can also use the GET operation to get custom properties and extension data in a group instance.

アクセス許可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、Group.ReadWrite.All、Directory.Read.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.
ApplicationApplication 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/{id}

省略可能なクエリ パラメーターOptional query parameters

既定では返されないものも含め、特定のグループのプロパティを取得するには $select を使用できます。You can use $select to get specific group properties, including those that are not returned by default. 次のを参照してください。See an example below.

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 group object in the response body. $select を使用して特定のプロパティを指定していない限り、既定のプロパティを返します。It returns the default properties unless you use $select to specify specific properties.

Example

要求 1Request 1

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

GET https://graph.microsoft.com/beta/groups/45b7d2e7-b882-4a80-ba97-10b7a63b8fa4

応答 1Response 1

応答の例を次に示します。The following is an example of the response. 既定のプロパティのみが含まれています。It includes only the default properties.

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

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

{
  "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": []
}

SDK サンプル コードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var group = await graphClient.Groups["45b7d2e7-b882-4a80-ba97-10b7a63b8fa4"]
    .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

$select クエリ オプションを使用して、既定では返されないいくつかのプロパティを取得する例を次に示します。The next example uses a $select query option to get a few properties that are not returned by default.

GET https://graph.microsoft.com/beta/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount

応答 2Response 2

要求された既定以外のプロパティを含む応答の例を次に示します。The following is an example of the response which includes the requested non-default properties.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount)/$entity",
    "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
    "allowExternalSenders": false,
    "autoSubscribeNewMembers": false,
    "isSubscribedByMail": false,
    "unseenCount": 0
}

SDK サンプル コードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var group = await graphClient.Groups["b320ee12-b1cd-4cca-b648-a437be61c5cd"]
    .Request()
    .Select( e => new {
             e.AllowExternalSenders,
             e.AutoSubscribeNewMembers,
             e.IsSubscribedByMail,
             e.UnseenCount 
             })
    .GetAsync();

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

関連項目See also