1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="clouduseraccounts_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_beta.groups.html">groups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addMember">addMember(project, groupName, body)</a></code></p> 79<p class="firstline">Adds users to the specified group.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, groupName)</a></code></p> 82<p class="firstline">Deletes the specified Group resource.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, groupName)</a></code></p> 85<p class="firstline">Returns the specified Group resource.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body)</a></code></p> 88<p class="firstline">Creates a Group resource in the specified project using the data included in the request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 91<p class="firstline">Retrieves the list of groups contained within the specified project.</p> 92<p class="toc_element"> 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"> 96 <code><a href="#removeMember">removeMember(project, groupName, body)</a></code></p> 97<p class="firstline">Removes users from the specified group.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="addMember">addMember(project, groupName, body)</code> 101 <pre>Adds users to the specified group. 102 103Args: 104 project: string, Project ID for this request. (required) 105 groupName: string, Name of the group for this request. (required) 106 body: object, The request body. (required) 107 The object takes the form of: 108 109{ 110 "users": [ # Fully-qualified URLs of the User resources to add. 111 "A String", 112 ], 113 } 114 115 116Returns: 117 An object of the form: 118 119 { # An Operation resource, used to manage asynchronous API requests. 120 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 121 "clientOperationId": "A String", # [Output Only] Reserved for future use. 122 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 123 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 124 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 125 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 126 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 127 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 128 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 129 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 130 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 131 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 132 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 133 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 134 { 135 "message": "A String", # [Output Only] A human-readable description of the warning code. 136 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 137 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 138 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 139 { 140 "value": "A String", # [Output Only] A warning data value corresponding to the key. 141 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 142 }, 143 ], 144 }, 145 ], 146 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 147 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 148 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 149 "name": "A String", # [Output Only] Name of the resource. 150 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 151 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 152 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 153 { 154 "message": "A String", # [Output Only] An optional, human-readable error message. 155 "code": "A String", # [Output Only] The error type identifier for this error. 156 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 157 }, 158 ], 159 }, 160 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 161 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 162 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 163 }</pre> 164</div> 165 166<div class="method"> 167 <code class="details" id="delete">delete(project, groupName)</code> 168 <pre>Deletes the specified Group resource. 169 170Args: 171 project: string, Project ID for this request. (required) 172 groupName: string, Name of the Group resource to delete. (required) 173 174Returns: 175 An object of the form: 176 177 { # An Operation resource, used to manage asynchronous API requests. 178 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 179 "clientOperationId": "A String", # [Output Only] Reserved for future use. 180 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 181 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 182 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 183 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 184 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 185 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 186 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 187 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 188 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 189 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 190 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 191 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 192 { 193 "message": "A String", # [Output Only] A human-readable description of the warning code. 194 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 195 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 196 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 197 { 198 "value": "A String", # [Output Only] A warning data value corresponding to the key. 199 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 200 }, 201 ], 202 }, 203 ], 204 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 205 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 206 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 207 "name": "A String", # [Output Only] Name of the resource. 208 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 209 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 210 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 211 { 212 "message": "A String", # [Output Only] An optional, human-readable error message. 213 "code": "A String", # [Output Only] The error type identifier for this error. 214 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 215 }, 216 ], 217 }, 218 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 219 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 220 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 221 }</pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="get">get(project, groupName)</code> 226 <pre>Returns the specified Group resource. 227 228Args: 229 project: string, Project ID for this request. (required) 230 groupName: string, Name of the Group resource to return. (required) 231 232Returns: 233 An object of the form: 234 235 { # A Group resource. 236 "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups. 237 "name": "A String", # Name of the resource; provided by the client when the resource is created. 238 "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project. 239 "A String", 240 ], 241 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 242 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 243 "selfLink": "A String", # [Output Only] Server defined URL for the resource. 244 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 245 }</pre> 246</div> 247 248<div class="method"> 249 <code class="details" id="insert">insert(project, body)</code> 250 <pre>Creates a Group resource in the specified project using the data included in the request. 251 252Args: 253 project: string, Project ID for this request. (required) 254 body: object, The request body. (required) 255 The object takes the form of: 256 257{ # A Group resource. 258 "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups. 259 "name": "A String", # Name of the resource; provided by the client when the resource is created. 260 "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project. 261 "A String", 262 ], 263 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 264 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 265 "selfLink": "A String", # [Output Only] Server defined URL for the resource. 266 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 267 } 268 269 270Returns: 271 An object of the form: 272 273 { # An Operation resource, used to manage asynchronous API requests. 274 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 275 "clientOperationId": "A String", # [Output Only] Reserved for future use. 276 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 277 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 278 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 279 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 280 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 281 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 282 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 283 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 284 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 285 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 286 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 287 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 288 { 289 "message": "A String", # [Output Only] A human-readable description of the warning code. 290 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 291 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 292 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 293 { 294 "value": "A String", # [Output Only] A warning data value corresponding to the key. 295 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 296 }, 297 ], 298 }, 299 ], 300 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 301 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 302 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 303 "name": "A String", # [Output Only] Name of the resource. 304 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 305 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 306 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 307 { 308 "message": "A String", # [Output Only] An optional, human-readable error message. 309 "code": "A String", # [Output Only] The error type identifier for this error. 310 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 311 }, 312 ], 313 }, 314 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 315 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 316 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 317 }</pre> 318</div> 319 320<div class="method"> 321 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 322 <pre>Retrieves the list of groups contained within the specified project. 323 324Args: 325 project: string, Project ID for this request. (required) 326 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 327 328You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. 329 330Currently, only sorting by name or creationTimestamp desc is supported. 331 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. 332 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. 333 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 334 335The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 336 337For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 338 339Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values. 340 341The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 342 343Returns: 344 An object of the form: 345 346 { 347 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. 348 "items": [ # [Output Only] A list of Group resources. 349 { # A Group resource. 350 "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups. 351 "name": "A String", # Name of the resource; provided by the client when the resource is created. 352 "members": [ # [Output Only] A list of URLs to User resources who belong to the group. Users may only be members of groups in the same project. 353 "A String", 354 ], 355 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 356 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 357 "selfLink": "A String", # [Output Only] Server defined URL for the resource. 358 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 359 }, 360 ], 361 "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups. 362 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 363 "selfLink": "A String", # [Output Only] Server defined URL for this resource. 364 }</pre> 365</div> 366 367<div class="method"> 368 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 369 <pre>Retrieves the next page of results. 370 371Args: 372 previous_request: The request for the previous page. (required) 373 previous_response: The response from the request for the previous page. (required) 374 375Returns: 376 A request object that you can call 'execute()' on to request the next 377 page. Returns None if there are no more items in the collection. 378 </pre> 379</div> 380 381<div class="method"> 382 <code class="details" id="removeMember">removeMember(project, groupName, body)</code> 383 <pre>Removes users from the specified group. 384 385Args: 386 project: string, Project ID for this request. (required) 387 groupName: string, Name of the group for this request. (required) 388 body: object, The request body. (required) 389 The object takes the form of: 390 391{ 392 "users": [ # Fully-qualified URLs of the User resources to remove. 393 "A String", 394 ], 395 } 396 397 398Returns: 399 An object of the form: 400 401 { # An Operation resource, used to manage asynchronous API requests. 402 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 403 "clientOperationId": "A String", # [Output Only] Reserved for future use. 404 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 405 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 406 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 407 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 408 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 409 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 410 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 411 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 412 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 413 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 414 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 415 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 416 { 417 "message": "A String", # [Output Only] A human-readable description of the warning code. 418 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 419 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 420 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 421 { 422 "value": "A String", # [Output Only] A warning data value corresponding to the key. 423 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 424 }, 425 ], 426 }, 427 ], 428 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 429 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 430 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 431 "name": "A String", # [Output Only] Name of the resource. 432 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 433 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 434 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 435 { 436 "message": "A String", # [Output Only] An optional, human-readable error message. 437 "code": "A String", # [Output Only] The error type identifier for this error. 438 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 439 }, 440 ], 441 }, 442 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 443 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 444 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 445 }</pre> 446</div> 447 448</body></html>