- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Creates a permission for a file or shared drive. For more information, see Share files, folders, and drives .
Warning:Concurrent permissions operations on the same file aren't supported; only the last update is applied.
HTTP request
POST https://www.googleapis.com/drive/v3/files/{fileId}/permissions
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
fileId
|
The ID of the file or shared drive. |
Query parameters
emailMessage
string
A plain text custom message to include in the notification email.
enforceSingleParent
(deprecated)
boolean
Deprecated: See moveToNewOwnersRoot
for details.
moveToNewOwnersRoot
boolean
This parameter only takes effect if the item isn't in a shared drive and the request is attempting to transfer the ownership of the item. If set to true
, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to false
, parents aren't changed.
sendNotificationEmail
boolean
Whether to send a notification email when sharing to users or groups. This defaults to true
for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
supportsAllDrives
boolean
Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives
(deprecated)
boolean
Deprecated: Use supportsAllDrives
instead.
transferOwnership
boolean
Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. For more information, see Transfer file ownership .
useDomainAdminAccess
boolean
Issue the request as a domain administrator.
If set to true
, and if the following additional conditions are met, the requester is granted access:
- The file ID parameter refers to a shared drive.
- The requester is an administrator of the domain to which the shared drive belongs.
For more information, see Manage shared drives as domain administrators .
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/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 .
