Skip to content

filestoragecontainer-list-sharepointgroups.md

Latest commit

 

History

History
197 lines (144 loc) · 7.47 KB

filestoragecontainer-list-sharepointgroups.md

File metadata and controls

197 lines (144 loc) · 7.47 KB
title List sharePointGroups
description Get a list of the sharePointGroup objects and their properties.
author tmarwendo-microsoft
ms.localizationpriority medium
ms.subservice onedrive
doc_type apiPageType
ms.date 1/31/2025

List sharePointGroups

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of sharePointGroup objects and their properties.

[!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

Optional query parameters

This method supports the $filter, $orderBy, $top, $skip, and $count OData query parameters to help customize the response. For general information, see OData query parameters.

Note

Only 100 sharePointGroup objects can be listed in a single request. Use the $top and $skip query parameters to efficiently retrieve all sharePointGroup objects in a fileStorageContainer.

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 collection of sharePointGroup objects in the response body.

Examples

Example 1: Retrieve all the existing sharePointGroup objects that are local to a fileStorageContainer

The following example retrieves all the sharePointGroup objects that are local to a fileStoragecontainer identified by the container ID b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z.

Request

The following example shows a request.

HTTP

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

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 that contains the collection of sharePointGroup objects available.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.sharePointGroup",
      "id": "7",
      "title": "sampleTitle1",
      "description": "sampleDescription1"
    },
    {
      "@odata.type": "#microsoft.graph.sharePointGroup",
      "id": "9",
      "title": "sampleTitle2",
      "description": "sampleDescription2"
    }
  ]
}

Example 2: Attempt to retrieve all the existing sharePointGroup objects that are local to a fileStorageContainer

The following example attempts to retrieve all the sharePointGroup objects that are local to a fileStorageContainer identified by the container ID b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z; however, the fileStorageContainer contains no sharePointGroup objects.

Request

The following example shows a request.

HTTP

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

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. Because no sharePointGroup objects exist in the fileStorageContainer, the response has an empty list.

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

{
  "value": []
}