Method: permissions.insert

Inserts a permission for a file or shared drive.

Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.

HTTP request

POST https://www.googleapis.com/drive/v2/files/{fileId}/permissions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
fileId

string

The ID for the file or shared drive.

Query parameters

Parameters
emailMessage

string

A plain text custom message to include in notification emails.
enforceSingleParent
(deprecated)

boolean

Deprecated: See moveToNewOwnersRoot for details.
moveToNewOwnersRoot

boolean

This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.
sendNotificationEmails

boolean

Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.
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.
enforceExpansiveAccess

boolean

Whether the request should enforce expansive access rules.

Request body

The request body contains an instance of Permission.

Response body

If successful, the response body contains a newly created instance of Permission.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.