1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
<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>
|
