<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.permissions.html">permissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(fileId, body, sendNotificationEmail=None, transferOwnership=None, emailMessage=None)</a></code></p>
<p class="firstline">Creates a permission for a file.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, permissionId)</a></code></p>
<p class="firstline">Deletes a permission.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, permissionId)</a></code></p>
<p class="firstline">Gets a permission by ID.</p>
<p class="toc_element">
<code><a href="#list">list(fileId)</a></code></p>
<p class="firstline">Lists a file's permissions.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</a></code></p>
<p class="firstline">Updates a permission with patch semantics.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(fileId, body, sendNotificationEmail=None, transferOwnership=None, emailMessage=None)</code>
<pre>Creates a permission for a file.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
# - owner
# - writer
# - commenter
# - reader
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}
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.
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.
emailMessage: string, A custom message to include in the notification email.
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
# - owner
# - writer
# - commenter
# - reader
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(fileId, permissionId)</code>
<pre>Deletes a permission.
Args:
fileId: string, The ID of the file. (required)
permissionId: string, The ID of the permission. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, permissionId)</code>
<pre>Gets a permission by ID.
Args:
fileId: string, The ID of the file. (required)
permissionId: string, The ID of the permission. (required)
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
# - owner
# - writer
# - commenter
# - reader
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId)</code>
<pre>Lists a file's permissions.
Args:
fileId: string, The ID of the file. (required)
Returns:
An object of the form:
{ # A list of permissions for a file.
"kind": "drive#permissionList", # Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".
"permissions": [ # The full list of permissions.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
# - owner
# - writer
# - commenter
# - reader
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</code>
<pre>Updates a permission with patch semantics.
Args:
fileId: string, The ID of the file. (required)
permissionId: string, The ID of the permission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
# - owner
# - writer
# - commenter
# - reader
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}
removeExpiration: boolean, Whether to remove the expiration date.
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.
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. Valid values are:
# - owner
# - writer
# - commenter
# - reader
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}</pre>
</div>
</body></html>