Lists a file's or shared drive's permissions. Try it now.
Request
HTTP request
GET https://www.googleapis.com/drive/v3/files/fileId/permissions
Parameters
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
fileId |
string |
The ID of the file or shared drive. |
| Optional query parameters | ||
fields |
string |
The paths of the fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. For development you can use the special value * to return all fields, but you'll achieve greater performance by only selecting the fields you need. For more information, see Return specific fields for a file.
|
includePermissionsForView |
string |
Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
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.
Acceptable values are 1 to 100, inclusive.
|
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.
(Default: false)
|
supportsTeamDrives |
boolean |
Deprecated use supportsAllDrives instead.
(Default: false)
|
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.
(Default: false)
|
Authorization
This request requires authorization with at least one of the following scopes:
| Scope |
|---|
https://www.googleapis.com/auth/drive |
https://www.googleapis.com/auth/drive.file |
https://www.googleapis.com/auth/drive.readonly |
https://www.googleapis.com/auth/drive.metadata.readonly |
https://www.googleapis.com/auth/drive.metadata |
https://www.googleapis.com/auth/drive.photos.readonly |
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": "drive#permissionList",
"nextPageToken": string,
"permissions": [
permissions Resource
]
}
| Property name | Value | Description | Notes |
|---|---|---|---|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "drive#permissionList". |
|
permissions[] |
list |
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. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.