Method: permissions.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists a file's or shared drive's permissions.
HTTP request
GET https://www.googleapis.com/drive/v3/files/{fileId}/permissions
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
fileId |
string
The ID of the file or shared drive.
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
|
pageToken |
string
The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
|
supportsAllDrives |
boolean
Whether the requesting application supports both My Drives and shared drives.
|
supportsTeamDrives
(deprecated) |
boolean
Deprecated: Use supportsAllDrives instead.
|
useDomainAdminAccess |
boolean
Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
|
includePermissionsForView |
string
Specifies which additional view's permissions to include in the response. Only 'published' is supported.
|
Request body
The request body must be empty.
Response body
A list of permissions for a file.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"permissions": [
{
object (Permission)
}
],
"nextPageToken": string,
"kind": string
} |
| Fields |
permissions[] |
object (Permission)
The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
|
nextPageToken |
string
The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.meet.readonly
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.photos.readonly
https://www.googleapis.com/auth/drive.readonly
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-23 UTC.
[null,null,["Last updated 2025-07-23 UTC."],[],[],null,["# Method: permissions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.PermissionList.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists a file's or shared drive's permissions.\n\n### HTTP request\n\n`GET https://www.googleapis.com/drive/v3/files/{fileId}/permissions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------|\n| `fileId` | `string` The ID of the file or shared drive. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. |\n| `pageToken` | `string` The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. |\n| `supportsAllDrives` | `boolean` Whether the requesting application supports both My Drives and shared drives. |\n| `supportsTeamDrives` **(deprecated)** | `boolean` Deprecated: Use `supportsAllDrives` instead. |\n| `useDomainAdminAccess` | `boolean` Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. |\n| `includePermissionsForView` | `string` Specifies which additional view's permissions to include in the response. Only 'published' is supported. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of permissions for a file.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"permissions\": [ { object (/workspace/drive/api/reference/rest/v3/permissions#Permission) } ], \"nextPageToken\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `permissions[]` | `object (`[Permission](/workspace/drive/api/reference/rest/v3/permissions#Permission)`)` The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |\n| `nextPageToken` | `string` The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"drive#permissionList\"`. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.meet.readonly`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n- `\n https://www.googleapis.com/auth/drive.metadata.readonly`\n- `\n https://www.googleapis.com/auth/drive.photos.readonly`\n- `\n https://www.googleapis.com/auth/drive.readonly`\n\nSome scopes are restricted and require a security assessment for your app to use them. For more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
