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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
|
<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_v2.html">Google Drive API</a> . <a href="drive_v2.permissions.html">permissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, permissionId, enforceExpansiveAccess=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a permission from a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a permission by ID.</p>
<p class="toc_element">
<code><a href="#getIdForEmail">getIdForEmail(email, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the permission ID for an email address.</p>
<p class="toc_element">
<code><a href="#insert">insert(fileId, body=None, emailMessage=None, enforceExpansiveAccess=None, enforceSingleParent=None, moveToNewOwnersRoot=None, sendNotificationEmails=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.</p>
<p class="toc_element">
<code><a href="#list">list(fileId, includePermissionsForView=None, maxResults=None, pageToken=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a file's or shared drive's permissions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a permission using patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(fileId, permissionId, enforceExpansiveAccess=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Deletes a permission from a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
Args:
fileId: string, The ID for the file or shared drive. (required)
permissionId: string, The ID for the permission. (required)
enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
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 shared drive and the requester is an administrator of the domain to which the shared drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Gets a permission by ID.
Args:
fileId: string, The ID for the file or shared drive. (required)
permissionId: string, The ID for the permission. (required)
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
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 shared drive and the requester is an administrator of the domain to which the shared drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
}</pre>
</div>
<div class="method">
<code class="details" id="getIdForEmail">getIdForEmail(email, x__xgafv=None)</code>
<pre>Returns the permission ID for an email address.
Args:
email: string, The email address for which to return a permission ID (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An ID for a user or group as seen in Permission items.
"id": "A String", # The permission ID.
"kind": "drive#permissionId", # This is always `drive#permissionId`.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(fileId, body=None, emailMessage=None, enforceExpansiveAccess=None, enforceSingleParent=None, moveToNewOwnersRoot=None, sendNotificationEmails=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Inserts a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
Args:
fileId: string, The ID for the file or shared drive. (required)
body: object, The request body.
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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
}
emailMessage: string, A plain text custom message to include in notification emails.
enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules.
enforceSingleParent: boolean, Deprecated: See `moveToNewOwnersRoot` for details.
moveToNewOwnersRoot: boolean, This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed.
sendNotificationEmails: boolean, Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the `role` is `owner`.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
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 shared drive and the requester is an administrator of the domain to which the shared drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId, includePermissionsForView=None, maxResults=None, pageToken=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Lists a file's or shared drive's permissions.
Args:
fileId: string, The ID for the file or shared drive. (required)
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
maxResults: integer, The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
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 shared drive and the requester is an administrator of the domain to which the shared drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of permissions associated with a file.
"etag": "A String", # The ETag of the list.
"items": [ # The 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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"kind": "drive#permissionList", # This is always `drive#permissionList`.
"nextPageToken": "A String", # The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
"selfLink": "A String", # A link back to this list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Updates a permission using patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
Args:
fileId: string, The ID for the file or shared drive. (required)
permissionId: string, The ID for the permission. (required)
body: object, The request body.
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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
}
enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules.
removeExpiration: boolean, Whether to remove the expiration date.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
transferOwnership: boolean, Whether changing a role to `owner` downgrades the current owners to writers. Does nothing if the specified role is not `owner`.
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 shared drive and the requester is an administrator of the domain to which the shared drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(fileId, permissionId, body=None, enforceExpansiveAccess=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Updates a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
Args:
fileId: string, The ID for the file or shared drive. (required)
permissionId: string, The ID for the permission. (required)
body: object, The request body.
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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
}
enforceExpansiveAccess: boolean, Whether the request should enforce expansive access rules.
removeExpiration: boolean, Whether to remove the expiration date.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
transferOwnership: boolean, Whether changing a role to `owner` downgrades the current owners to writers. Does nothing if the specified role is not `owner`.
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 shared drive and the requester is an administrator of the domain to which the shared drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"domain": "A String", # Output only. 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`.
"emailAddress": "A String", # Output only. 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`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"inheritedPermissionsDisabled": True or False, # When true, only organizers, owners, and users with permissions added directly on the item can access it.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this permission.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this item are inherited or directly on this item.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A 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 unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.
"withLink": True or False, # Whether the link is required for this permission.
}</pre>
</div>
</body></html>
|
