Click here to see your recently viewed pages and most viewed pages.
Hide
Drive REST API

Permissions

For a list of methods for this resource, see the end of this page.

Resource representations

A permission for a file.

{
  "kind": "drive#permission",
  "etag": etag,
  "id": string,
  "selfLink": string,
  "name": string,
  "emailAddress": string,
  "domain": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "type": string,
  "value": string,
  "authKey": string,
  "withLink": boolean,
  "photoLink": string
}
Property name Value Description Notes
kind string This is always drive#permission.
etag etag The ETag of the permission.
id string The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified. writable
name string The name for this permission.
role string The primary role for this user. Allowed values are:
  • owner
  • reader
  • writer
writable
additionalRoles[] list Additional roles for this user. Only commenter is currently allowed. writable
type string The account type. Allowed values are:
  • user
  • group
  • domain
  • anyone
writable
authKey string The authkey parameter required for this permission.
value string The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified. writable
emailAddress string The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
domain string The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.

Methods

delete
Deletes a permission from a file.
get
Gets a permission by ID.
insert
Inserts a permission for a file.
list
Lists a file's permissions.
patch
Updates a permission. This method supports patch semantics.
update
Updates a permission.
getIdForEmail
Returns the permission ID for an email address.