Rediger

List sharePointGroups

Namespace: microsoft.graph

Get a list of sharePointGroup objects and their properties.

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application FileStorageContainer.Selected Not available.

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.

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

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": "ZGYwZTEzYTgtOTExOS00MjdmLWEzNjktOTdjOWM3YjNlYjcyXzE0",
      "title": "sampleTitle1",
      "description": "sampleDescription1",
      "principalId": "7"
    },
    {
      "@odata.type": "#microsoft.graph.sharePointGroup",
      "id": "ZGYwZTEzYTgtOTExOS00PdjfPUHzNjktOTdjOWM3YjNlYjcyOpo8",
      "title": "sampleTitle2",
      "description": "sampleDescription2",
      "principalId": "9"
    }
  ]
}

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_6A; however, the fileStorageContainer contains no sharePointGroup objects.

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_6A/sharePointGroups

Response

The following example shows the response. The response has an empty list, because no sharePointGroup objects exist in the fileStorageContainer.

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

{
  "value": []
}
  • Last updated on