Permissions: create

Requires authorization

Creates a permission for a file or Team Drive. Try it now.


HTTP request



Parameter name Value Description
Path parameters
fileId string The ID of the file or Team Drive.
Optional query parameters
emailMessage string A plain text custom message to include in the notification email.
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 the partial responses documentation.
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.
supportsTeamDrives boolean Whether the requesting application supports Team Drives. (Default: false)
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. (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 Team Drive and the requester is an administrator of the domain to which the Team Drive belongs. (Default: false)


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

In the request body, supply a Permissions resource with the following properties:

Property name Value Description Notes
Required Properties
role string The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
type string The type of the grantee. Valid values are:
  • user
  • group
  • domain
  • anyone
Optional Properties
allowFileDiscovery boolean Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone. writable
domain string The domain to which this permission refers. writable
emailAddress string The email address of the user or group to which this permission refers. writable


If successful, this method returns a Permissions resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Need help? Visit our support page.