| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.permissions.html">permissions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 78 | <code><a href="#delete">delete(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Deletes a permission from a file or shared drive.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#get">get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Gets a permission by ID.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#getIdForEmail">getIdForEmail(email)</a></code></p> |
| 85 | <p class="firstline">Returns the permission ID for an email address.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | <code><a href="#insert">insert(fileId, body=None, emailMessage=None, enforceSingleParent=None, moveToNewOwnersRoot=None, sendNotificationEmails=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Inserts a permission for a file or shared drive.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 90 | <code><a href="#list">list(fileId, maxResults=None, pageToken=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Lists a file's or shared drive's permissions.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 92 | <p class="toc_element"> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 96 | <code><a href="#patch">patch(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 97 | <p class="firstline">Updates a permission using patch semantics.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 98 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 99 | <code><a href="#update">update(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | <p class="firstline">Updates a permission.</p> |
| 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | <code class="details" id="delete">delete(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 104 | <pre>Deletes a permission from a file or shared drive. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | |
| 106 | Args: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | fileId: string, The ID for the file or shared drive. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 108 | permissionId: string, The ID for the permission. (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 109 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 111 | 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 112 | </pre> |
| 113 | </div> |
| 114 | |
| 115 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | <code class="details" id="get">get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 117 | <pre>Gets a permission by ID. |
| 118 | |
| 119 | Args: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | fileId: string, The ID for the file or shared drive. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 121 | permissionId: string, The ID for the permission. (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 122 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 124 | 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 125 | |
| 126 | Returns: |
| 127 | An object of the form: |
| 128 | |
| 129 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 130 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 131 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 132 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 133 | "authKey": "A String", # Deprecated. |
| 134 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 135 | "domain": "A 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. |
| 136 | "emailAddress": "A 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. |
| 137 | "etag": "A String", # The ETag of the permission. |
| 138 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 139 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 140 | # - They can only be set on user and group permissions |
| 141 | # - The date must be in the future |
| 142 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 143 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | "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. |
| 145 | "kind": "drive#permission", # This is always drive#permission. |
| 146 | "name": "A String", # The name for this permission. |
| 147 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 148 | { |
| 149 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 150 | "A String", |
| 151 | ], |
| 152 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 153 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 154 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 155 | # - file |
| 156 | # - member |
| 157 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 158 | # - organizer |
| 159 | # - fileOrganizer |
| 160 | # - writer |
| 161 | # - reader |
| 162 | }, |
| 163 | ], |
| 164 | "photoLink": "A String", # A link to the profile photo, if available. |
| 165 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 166 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 167 | # - organizer |
| 168 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 169 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 170 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | "selfLink": "A String", # A link back to this permission. |
| 172 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 173 | { |
| 174 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 175 | "A String", |
| 176 | ], |
| 177 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 178 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 179 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 180 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 181 | }, |
| 182 | ], |
| 183 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 184 | # - user |
| 185 | # - group |
| 186 | # - domain |
| 187 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 188 | "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. |
| 189 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 190 | }</pre> |
| 191 | </div> |
| 192 | |
| 193 | <div class="method"> |
| 194 | <code class="details" id="getIdForEmail">getIdForEmail(email)</code> |
| 195 | <pre>Returns the permission ID for an email address. |
| 196 | |
| 197 | Args: |
| 198 | email: string, The email address for which to return a permission ID (required) |
| 199 | |
| 200 | Returns: |
| 201 | An object of the form: |
| 202 | |
| 203 | { # An ID for a user or group as seen in Permission items. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 204 | "id": "A String", # The permission ID. |
| 205 | "kind": "drive#permissionId", # This is always drive#permissionId. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 206 | }</pre> |
| 207 | </div> |
| 208 | |
| 209 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 210 | <code class="details" id="insert">insert(fileId, body=None, emailMessage=None, enforceSingleParent=None, moveToNewOwnersRoot=None, sendNotificationEmails=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 211 | <pre>Inserts a permission for a file or shared drive. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 212 | |
| 213 | Args: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 214 | fileId: string, The ID for the file or shared drive. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 215 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 216 | The object takes the form of: |
| 217 | |
| 218 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 219 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 220 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 221 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 222 | "authKey": "A String", # Deprecated. |
| 223 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 224 | "domain": "A 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. |
| 225 | "emailAddress": "A 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. |
| 226 | "etag": "A String", # The ETag of the permission. |
| 227 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 228 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 229 | # - They can only be set on user and group permissions |
| 230 | # - The date must be in the future |
| 231 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 232 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 233 | "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. |
| 234 | "kind": "drive#permission", # This is always drive#permission. |
| 235 | "name": "A String", # The name for this permission. |
| 236 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 237 | { |
| 238 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 239 | "A String", |
| 240 | ], |
| 241 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 242 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 243 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 244 | # - file |
| 245 | # - member |
| 246 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 247 | # - organizer |
| 248 | # - fileOrganizer |
| 249 | # - writer |
| 250 | # - reader |
| 251 | }, |
| 252 | ], |
| 253 | "photoLink": "A String", # A link to the profile photo, if available. |
| 254 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 255 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 256 | # - organizer |
| 257 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 258 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 259 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 260 | "selfLink": "A String", # A link back to this permission. |
| 261 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 262 | { |
| 263 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 264 | "A String", |
| 265 | ], |
| 266 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 267 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 268 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 269 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 270 | }, |
| 271 | ], |
| 272 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 273 | # - user |
| 274 | # - group |
| 275 | # - domain |
| 276 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 277 | "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. |
| 278 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 279 | } |
| 280 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 281 | emailMessage: string, A plain text custom message to include in notification emails. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 282 | enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. |
| 283 | moveToNewOwnersRoot: boolean, This parameter only takes effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When 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, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. |
| 284 | 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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 285 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 287 | 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 288 | |
| 289 | Returns: |
| 290 | An object of the form: |
| 291 | |
| 292 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 293 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 294 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 295 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 296 | "authKey": "A String", # Deprecated. |
| 297 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 298 | "domain": "A 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. |
| 299 | "emailAddress": "A 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. |
| 300 | "etag": "A String", # The ETag of the permission. |
| 301 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 302 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 303 | # - They can only be set on user and group permissions |
| 304 | # - The date must be in the future |
| 305 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 306 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | "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. |
| 308 | "kind": "drive#permission", # This is always drive#permission. |
| 309 | "name": "A String", # The name for this permission. |
| 310 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 311 | { |
| 312 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 313 | "A String", |
| 314 | ], |
| 315 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 316 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 317 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 318 | # - file |
| 319 | # - member |
| 320 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 321 | # - organizer |
| 322 | # - fileOrganizer |
| 323 | # - writer |
| 324 | # - reader |
| 325 | }, |
| 326 | ], |
| 327 | "photoLink": "A String", # A link to the profile photo, if available. |
| 328 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 329 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 330 | # - organizer |
| 331 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 332 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 333 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 334 | "selfLink": "A String", # A link back to this permission. |
| 335 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 336 | { |
| 337 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 338 | "A String", |
| 339 | ], |
| 340 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 341 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 342 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 343 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 344 | }, |
| 345 | ], |
| 346 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 347 | # - user |
| 348 | # - group |
| 349 | # - domain |
| 350 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 351 | "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. |
| 352 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 353 | }</pre> |
| 354 | </div> |
| 355 | |
| 356 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 357 | <code class="details" id="list">list(fileId, maxResults=None, pageToken=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)</code> |
| 358 | <pre>Lists a file's or shared drive's permissions. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 359 | |
| 360 | Args: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 361 | fileId: string, The ID for the file or shared drive. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 362 | 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 363 | 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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 364 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 365 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| 366 | 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 367 | |
| 368 | Returns: |
| 369 | An object of the form: |
| 370 | |
| 371 | { # A list of permissions associated with a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | "etag": "A String", # The ETag of the list. |
| 373 | "items": [ # The list of permissions. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 374 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 375 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 376 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 377 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 378 | "authKey": "A String", # Deprecated. |
| 379 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 380 | "domain": "A 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. |
| 381 | "emailAddress": "A 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. |
| 382 | "etag": "A String", # The ETag of the permission. |
| 383 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 384 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 385 | # - They can only be set on user and group permissions |
| 386 | # - The date must be in the future |
| 387 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 388 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 389 | "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. |
| 390 | "kind": "drive#permission", # This is always drive#permission. |
| 391 | "name": "A String", # The name for this permission. |
| 392 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 393 | { |
| 394 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 395 | "A String", |
| 396 | ], |
| 397 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 398 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 399 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 400 | # - file |
| 401 | # - member |
| 402 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 403 | # - organizer |
| 404 | # - fileOrganizer |
| 405 | # - writer |
| 406 | # - reader |
| 407 | }, |
| 408 | ], |
| 409 | "photoLink": "A String", # A link to the profile photo, if available. |
| 410 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 411 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 412 | # - organizer |
| 413 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 414 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 415 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 416 | "selfLink": "A String", # A link back to this permission. |
| 417 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 418 | { |
| 419 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 420 | "A String", |
| 421 | ], |
| 422 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 423 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 424 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 425 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 426 | }, |
| 427 | ], |
| 428 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 429 | # - user |
| 430 | # - group |
| 431 | # - domain |
| 432 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | "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. |
| 434 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 435 | }, |
| 436 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 437 | "kind": "drive#permissionList", # This is always drive#permissionList. |
| 438 | "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. |
| 439 | "selfLink": "A String", # A link back to this list. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 440 | }</pre> |
| 441 | </div> |
| 442 | |
| 443 | <div class="method"> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 444 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 445 | <pre>Retrieves the next page of results. |
| 446 | |
| 447 | Args: |
| 448 | previous_request: The request for the previous page. (required) |
| 449 | previous_response: The response from the request for the previous page. (required) |
| 450 | |
| 451 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 452 | A request object that you can call 'execute()' on to request the next |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 453 | page. Returns None if there are no more items in the collection. |
| 454 | </pre> |
| 455 | </div> |
| 456 | |
| 457 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 458 | <code class="details" id="patch">patch(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 459 | <pre>Updates a permission using patch semantics. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 460 | |
| 461 | Args: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 462 | fileId: string, The ID for the file or shared drive. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 463 | permissionId: string, The ID for the permission. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 464 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 465 | The object takes the form of: |
| 466 | |
| 467 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 468 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 469 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 470 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 471 | "authKey": "A String", # Deprecated. |
| 472 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 473 | "domain": "A 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. |
| 474 | "emailAddress": "A 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. |
| 475 | "etag": "A String", # The ETag of the permission. |
| 476 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 477 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 478 | # - They can only be set on user and group permissions |
| 479 | # - The date must be in the future |
| 480 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 481 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 482 | "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. |
| 483 | "kind": "drive#permission", # This is always drive#permission. |
| 484 | "name": "A String", # The name for this permission. |
| 485 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 486 | { |
| 487 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 488 | "A String", |
| 489 | ], |
| 490 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 491 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 492 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 493 | # - file |
| 494 | # - member |
| 495 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 496 | # - organizer |
| 497 | # - fileOrganizer |
| 498 | # - writer |
| 499 | # - reader |
| 500 | }, |
| 501 | ], |
| 502 | "photoLink": "A String", # A link to the profile photo, if available. |
| 503 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 504 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 505 | # - organizer |
| 506 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 507 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 508 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 509 | "selfLink": "A String", # A link back to this permission. |
| 510 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 511 | { |
| 512 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 513 | "A String", |
| 514 | ], |
| 515 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 516 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 517 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 518 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 519 | }, |
| 520 | ], |
| 521 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 522 | # - user |
| 523 | # - group |
| 524 | # - domain |
| 525 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 526 | "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. |
| 527 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 528 | } |
| 529 | |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 530 | removeExpiration: boolean, Whether to remove the expiration date. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 531 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 532 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| 533 | transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 534 | 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 535 | |
| 536 | Returns: |
| 537 | An object of the form: |
| 538 | |
| 539 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 540 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 541 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 542 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 543 | "authKey": "A String", # Deprecated. |
| 544 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 545 | "domain": "A 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. |
| 546 | "emailAddress": "A 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. |
| 547 | "etag": "A String", # The ETag of the permission. |
| 548 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 549 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 550 | # - They can only be set on user and group permissions |
| 551 | # - The date must be in the future |
| 552 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 553 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 554 | "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. |
| 555 | "kind": "drive#permission", # This is always drive#permission. |
| 556 | "name": "A String", # The name for this permission. |
| 557 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 558 | { |
| 559 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 560 | "A String", |
| 561 | ], |
| 562 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 563 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 564 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 565 | # - file |
| 566 | # - member |
| 567 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 568 | # - organizer |
| 569 | # - fileOrganizer |
| 570 | # - writer |
| 571 | # - reader |
| 572 | }, |
| 573 | ], |
| 574 | "photoLink": "A String", # A link to the profile photo, if available. |
| 575 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 576 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 577 | # - organizer |
| 578 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 579 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 580 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 581 | "selfLink": "A String", # A link back to this permission. |
| 582 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 583 | { |
| 584 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 585 | "A String", |
| 586 | ], |
| 587 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 588 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 589 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 590 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 591 | }, |
| 592 | ], |
| 593 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 594 | # - user |
| 595 | # - group |
| 596 | # - domain |
| 597 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 598 | "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. |
| 599 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 600 | }</pre> |
| 601 | </div> |
| 602 | |
| 603 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 604 | <code class="details" id="update">update(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 605 | <pre>Updates a permission. |
| 606 | |
| 607 | Args: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 608 | fileId: string, The ID for the file or shared drive. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 609 | permissionId: string, The ID for the permission. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 610 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 611 | The object takes the form of: |
| 612 | |
| 613 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 614 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 615 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 616 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 617 | "authKey": "A String", # Deprecated. |
| 618 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 619 | "domain": "A 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. |
| 620 | "emailAddress": "A 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. |
| 621 | "etag": "A String", # The ETag of the permission. |
| 622 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 623 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 624 | # - They can only be set on user and group permissions |
| 625 | # - The date must be in the future |
| 626 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 627 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 628 | "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. |
| 629 | "kind": "drive#permission", # This is always drive#permission. |
| 630 | "name": "A String", # The name for this permission. |
| 631 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 632 | { |
| 633 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 634 | "A String", |
| 635 | ], |
| 636 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 637 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 638 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 639 | # - file |
| 640 | # - member |
| 641 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 642 | # - organizer |
| 643 | # - fileOrganizer |
| 644 | # - writer |
| 645 | # - reader |
| 646 | }, |
| 647 | ], |
| 648 | "photoLink": "A String", # A link to the profile photo, if available. |
| 649 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 650 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 651 | # - organizer |
| 652 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 653 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 654 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 655 | "selfLink": "A String", # A link back to this permission. |
| 656 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 657 | { |
| 658 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 659 | "A String", |
| 660 | ], |
| 661 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 662 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 663 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 664 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 665 | }, |
| 666 | ], |
| 667 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 668 | # - user |
| 669 | # - group |
| 670 | # - domain |
| 671 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 672 | "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. |
| 673 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 674 | } |
| 675 | |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 676 | removeExpiration: boolean, Whether to remove the expiration date. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 677 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 678 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| 679 | transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 680 | 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. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 681 | |
| 682 | Returns: |
| 683 | An object of the form: |
| 684 | |
| 685 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 686 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 687 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 688 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 689 | "authKey": "A String", # Deprecated. |
| 690 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 691 | "domain": "A 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. |
| 692 | "emailAddress": "A 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. |
| 693 | "etag": "A String", # The ETag of the permission. |
| 694 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 695 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 696 | # - They can only be set on user and group permissions |
| 697 | # - The date must be in the future |
| 698 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 699 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 700 | "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. |
| 701 | "kind": "drive#permission", # This is always drive#permission. |
| 702 | "name": "A String", # The name for this permission. |
| 703 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 704 | { |
| 705 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 706 | "A String", |
| 707 | ], |
| 708 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 709 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 710 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 711 | # - file |
| 712 | # - member |
| 713 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 714 | # - organizer |
| 715 | # - fileOrganizer |
| 716 | # - writer |
| 717 | # - reader |
| 718 | }, |
| 719 | ], |
| 720 | "photoLink": "A String", # A link to the profile photo, if available. |
| 721 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 722 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 723 | # - organizer |
| 724 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 725 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 726 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 727 | "selfLink": "A String", # A link back to this permission. |
| 728 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 729 | { |
| 730 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 731 | "A String", |
| 732 | ], |
| 733 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 734 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 735 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 736 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 737 | }, |
| 738 | ], |
| 739 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 740 | # - user |
| 741 | # - group |
| 742 | # - domain |
| 743 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 744 | "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. |
| 745 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 746 | }</pre> |
| 747 | </div> |
| 748 | |
| 749 | </body></html> |