Skip to content

sharepointgroup-get.md

Latest commit

 

History

History
189 lines (136 loc) · 7.06 KB

sharepointgroup-get.md

File metadata and controls

189 lines (136 loc) · 7.06 KB
title Get sharePointGroup
description Read the properties and relationships of a sharePointGroup object.
author tmarwendo-microsoft
ms.localizationpriority medium
ms.subservice onedrive
doc_type apiPageType
ms.date 1/31/2025

Get sharePointGroup

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Read the properties and relationships of a sharePointGroup object.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

Note

In addition to Microsoft Graph permissions, applications calling this API must at least have the EnumeratePermissions container type-level permission on the container type of the corresponding containers. For more information, see container types. To learn more about container type-level permissions, see SharePoint Embedded authorization.

HTTP request

GET /storage/fileStorage/containers/{fileStorageContainerId}/sharePointGroups/{sharePointGroupId}

Optional query parameters

This method supports the $expand and $select OData query parameters to help customize the response. For general information, see OData query parameters. For the $expand query parameter, only the members property is supported. The $select query parameter can be used with the title, id, and description properties of the sharePointGroup object.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a sharePointGroup object in the response body.

Examples

Example 1: Get a sharePointGroup by ID

The following example shows how to get a sharePointGroup identified by 10 that is local to a fileStorageContainer identified by b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/sharePointGroups/10

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response with a JSON object that represents the sharePointGroup.

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

{
  "@odata.type": "#microsoft.graph.sharePointGroup",
  "id" : "10",
  "title": "Sample Group",
  "description": "This is sample description"
}

Example 2: Attempt to get a sharePointGroup by ID

The following example attempts to get a sharePointGroup identified by 12 that is local to a fileStorageContainer identified by b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z; however, the group doesn't exist in the container.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/sharePointGroups/12

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response for a group that doesn't exist.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": "itemNotFound",
    "message": "Item not found"
  }
}