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_alpha.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_alpha.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="#getIamPolicy">getIamPolicy(project, resource)</a></code></p> 88<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, body)</a></code></p> 91<p class="firstline">Creates a Group resource in the specified project using the data included in the request.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">Retrieves the list of groups contained within the specified project.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#removeMember">removeMember(project, groupName, body)</a></code></p> 100<p class="firstline">Removes users from the specified group.</p> 101<p class="toc_element"> 102 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p> 103<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 104<p class="toc_element"> 105 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 106<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="addMember">addMember(project, groupName, body)</code> 110 <pre>Adds users to the specified group. 111 112Args: 113 project: string, Project ID for this request. (required) 114 groupName: string, Name of the group for this request. (required) 115 body: object, The request body. (required) 116 The object takes the form of: 117 118{ 119 "users": [ # Fully-qualified URLs of the User resources to add. 120 "A String", 121 ], 122 } 123 124 125Returns: 126 An object of the form: 127 128 { # An Operation resource, used to manage asynchronous API requests. 129 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 130 "clientOperationId": "A String", # [Output Only] Reserved for future use. 131 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 132 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 133 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 134 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 135 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 136 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 137 "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. 138 "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. 139 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 140 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 141 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 142 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 143 { 144 "message": "A String", # [Output Only] A human-readable description of the warning code. 145 "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. 146 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 147 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 148 { 149 "value": "A String", # [Output Only] A warning data value corresponding to the key. 150 "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). 151 }, 152 ], 153 }, 154 ], 155 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 156 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 157 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 158 "name": "A String", # [Output Only] Name of the resource. 159 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 160 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 161 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 162 { 163 "message": "A String", # [Output Only] An optional, human-readable error message. 164 "code": "A String", # [Output Only] The error type identifier for this error. 165 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 166 }, 167 ], 168 }, 169 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 170 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 171 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 172 }</pre> 173</div> 174 175<div class="method"> 176 <code class="details" id="delete">delete(project, groupName)</code> 177 <pre>Deletes the specified Group resource. 178 179Args: 180 project: string, Project ID for this request. (required) 181 groupName: string, Name of the Group resource to delete. (required) 182 183Returns: 184 An object of the form: 185 186 { # An Operation resource, used to manage asynchronous API requests. 187 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 188 "clientOperationId": "A String", # [Output Only] Reserved for future use. 189 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 190 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 191 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 192 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 193 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 194 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 195 "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. 196 "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. 197 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 198 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 199 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 200 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 201 { 202 "message": "A String", # [Output Only] A human-readable description of the warning code. 203 "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. 204 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 205 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 206 { 207 "value": "A String", # [Output Only] A warning data value corresponding to the key. 208 "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). 209 }, 210 ], 211 }, 212 ], 213 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 214 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 215 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 216 "name": "A String", # [Output Only] Name of the resource. 217 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 218 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 219 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 220 { 221 "message": "A String", # [Output Only] An optional, human-readable error message. 222 "code": "A String", # [Output Only] The error type identifier for this error. 223 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 224 }, 225 ], 226 }, 227 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 228 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 229 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 230 }</pre> 231</div> 232 233<div class="method"> 234 <code class="details" id="get">get(project, groupName)</code> 235 <pre>Returns the specified Group resource. 236 237Args: 238 project: string, Project ID for this request. (required) 239 groupName: string, Name of the Group resource to return. (required) 240 241Returns: 242 An object of the form: 243 244 { # A Group resource. 245 "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups. 246 "name": "A String", # Name of the resource; provided by the client when the resource is created. 247 "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. 248 "A String", 249 ], 250 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 251 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 252 "selfLink": "A String", # [Output Only] Server defined URL for the resource. 253 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 254 }</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code> 259 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 260 261Args: 262 project: string, Project ID for this request. (required) 263 resource: string, Name of the resource for this request. (required) 264 265Returns: 266 An object of the form: 267 268 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 269 # 270 # 271 # 272 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 273 # 274 # **Example** 275 # 276 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 277 # 278 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 279 "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes. 280 # 281 # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging. 282 { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted. 283 "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members. 284 "A String", 285 ], 286 "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services. 287 }, 288 ], 289 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 290 { # A rule to be applied in a Policy. 291 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 292 { # Specifies what kind of log the caller must write 293 "counter": { # Options for counters # Counter options. 294 "field": "A String", # The field value to attribute. 295 "metric": "A String", # The metric to update. 296 }, 297 }, 298 ], 299 "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. 300 "A String", 301 ], 302 "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries. 303 "A String", 304 ], 305 "action": "A String", # Required 306 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 307 "A String", 308 ], 309 "conditions": [ # Additional restrictions that must be met 310 { # A condition to be met. 311 "iam": "A String", # Trusted attributes supplied by the IAM system. 312 "svc": "A String", # Trusted attributes discharged by the service. 313 "value": "A String", # The object of the condition. Exactly one of these must be set. 314 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 315 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 316 "A String", 317 ], 318 "op": "A String", # An operator to apply the subject with. 319 }, 320 ], 321 "description": "A String", # Human-readable description of the rule. 322 }, 323 ], 324 "version": 42, # Version of the `Policy`. The default version is 0. 325 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. 326 # 327 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 328 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 329 { # Associates `members` with a `role`. 330 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 331 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 332 # 333 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 334 # 335 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 336 # 337 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. 338 # 339 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 340 # 341 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 342 # 343 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 344 "A String", 345 ], 346 }, 347 ], 348 "iamOwned": True or False, 349 }</pre> 350</div> 351 352<div class="method"> 353 <code class="details" id="insert">insert(project, body)</code> 354 <pre>Creates a Group resource in the specified project using the data included in the request. 355 356Args: 357 project: string, Project ID for this request. (required) 358 body: object, The request body. (required) 359 The object takes the form of: 360 361{ # A Group resource. 362 "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups. 363 "name": "A String", # Name of the resource; provided by the client when the resource is created. 364 "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. 365 "A String", 366 ], 367 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 368 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 369 "selfLink": "A String", # [Output Only] Server defined URL for the resource. 370 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 371 } 372 373 374Returns: 375 An object of the form: 376 377 { # An Operation resource, used to manage asynchronous API requests. 378 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 379 "clientOperationId": "A String", # [Output Only] Reserved for future use. 380 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 381 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 382 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 383 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 384 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 385 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 386 "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. 387 "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. 388 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 389 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 390 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 391 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 392 { 393 "message": "A String", # [Output Only] A human-readable description of the warning code. 394 "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. 395 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 396 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 397 { 398 "value": "A String", # [Output Only] A warning data value corresponding to the key. 399 "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). 400 }, 401 ], 402 }, 403 ], 404 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 405 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 406 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 407 "name": "A String", # [Output Only] Name of the resource. 408 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 409 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 410 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 411 { 412 "message": "A String", # [Output Only] An optional, human-readable error message. 413 "code": "A String", # [Output Only] The error type identifier for this error. 414 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 415 }, 416 ], 417 }, 418 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 419 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 420 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 421 }</pre> 422</div> 423 424<div class="method"> 425 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 426 <pre>Retrieves the list of groups contained within the specified project. 427 428Args: 429 project: string, Project ID for this request. (required) 430 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 431 432You 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. 433 434Currently, only sorting by name or creationTimestamp desc is supported. 435 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. 436 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. 437 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. 438 439The 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. 440 441For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 442 443Compute 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. 444 445The 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. 446 447Returns: 448 An object of the form: 449 450 { 451 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. 452 "items": [ # [Output Only] A list of Group resources. 453 { # A Group resource. 454 "kind": "clouduseraccounts#group", # [Output Only] Type of the resource. Always clouduseraccounts#group for groups. 455 "name": "A String", # Name of the resource; provided by the client when the resource is created. 456 "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. 457 "A String", 458 ], 459 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 460 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 461 "selfLink": "A String", # [Output Only] Server defined URL for the resource. 462 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 463 }, 464 ], 465 "kind": "clouduseraccounts#groupList", # [Output Only] Type of resource. Always clouduseraccounts#groupList for lists of groups. 466 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 467 "selfLink": "A String", # [Output Only] Server defined URL for this resource. 468 }</pre> 469</div> 470 471<div class="method"> 472 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 473 <pre>Retrieves the next page of results. 474 475Args: 476 previous_request: The request for the previous page. (required) 477 previous_response: The response from the request for the previous page. (required) 478 479Returns: 480 A request object that you can call 'execute()' on to request the next 481 page. Returns None if there are no more items in the collection. 482 </pre> 483</div> 484 485<div class="method"> 486 <code class="details" id="removeMember">removeMember(project, groupName, body)</code> 487 <pre>Removes users from the specified group. 488 489Args: 490 project: string, Project ID for this request. (required) 491 groupName: string, Name of the group for this request. (required) 492 body: object, The request body. (required) 493 The object takes the form of: 494 495{ 496 "users": [ # Fully-qualified URLs of the User resources to remove. 497 "A String", 498 ], 499 } 500 501 502Returns: 503 An object of the form: 504 505 { # An Operation resource, used to manage asynchronous API requests. 506 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 507 "clientOperationId": "A String", # [Output Only] Reserved for future use. 508 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 509 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 510 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 511 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 512 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 513 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 514 "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. 515 "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. 516 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 517 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 518 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 519 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 520 { 521 "message": "A String", # [Output Only] A human-readable description of the warning code. 522 "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. 523 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 524 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 525 { 526 "value": "A String", # [Output Only] A warning data value corresponding to the key. 527 "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). 528 }, 529 ], 530 }, 531 ], 532 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 533 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 534 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 535 "name": "A String", # [Output Only] Name of the resource. 536 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 537 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 538 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 539 { 540 "message": "A String", # [Output Only] An optional, human-readable error message. 541 "code": "A String", # [Output Only] The error type identifier for this error. 542 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 543 }, 544 ], 545 }, 546 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 547 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 548 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 549 }</pre> 550</div> 551 552<div class="method"> 553 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code> 554 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 555 556Args: 557 project: string, Project ID for this request. (required) 558 resource: string, Name of the resource for this request. (required) 559 body: object, The request body. (required) 560 The object takes the form of: 561 562{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 563 # 564 # 565 # 566 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 567 # 568 # **Example** 569 # 570 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 571 # 572 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 573 "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes. 574 # 575 # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging. 576 { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted. 577 "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members. 578 "A String", 579 ], 580 "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services. 581 }, 582 ], 583 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 584 { # A rule to be applied in a Policy. 585 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 586 { # Specifies what kind of log the caller must write 587 "counter": { # Options for counters # Counter options. 588 "field": "A String", # The field value to attribute. 589 "metric": "A String", # The metric to update. 590 }, 591 }, 592 ], 593 "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. 594 "A String", 595 ], 596 "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries. 597 "A String", 598 ], 599 "action": "A String", # Required 600 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 601 "A String", 602 ], 603 "conditions": [ # Additional restrictions that must be met 604 { # A condition to be met. 605 "iam": "A String", # Trusted attributes supplied by the IAM system. 606 "svc": "A String", # Trusted attributes discharged by the service. 607 "value": "A String", # The object of the condition. Exactly one of these must be set. 608 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 609 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 610 "A String", 611 ], 612 "op": "A String", # An operator to apply the subject with. 613 }, 614 ], 615 "description": "A String", # Human-readable description of the rule. 616 }, 617 ], 618 "version": 42, # Version of the `Policy`. The default version is 0. 619 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. 620 # 621 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 622 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 623 { # Associates `members` with a `role`. 624 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 625 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 626 # 627 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 628 # 629 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 630 # 631 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. 632 # 633 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 634 # 635 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 636 # 637 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 638 "A String", 639 ], 640 }, 641 ], 642 "iamOwned": True or False, 643} 644 645 646Returns: 647 An object of the form: 648 649 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 650 # 651 # 652 # 653 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 654 # 655 # **Example** 656 # 657 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 658 # 659 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 660 "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes. 661 # 662 # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging. 663 { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted. 664 "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members. 665 "A String", 666 ], 667 "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services. 668 }, 669 ], 670 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 671 { # A rule to be applied in a Policy. 672 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 673 { # Specifies what kind of log the caller must write 674 "counter": { # Options for counters # Counter options. 675 "field": "A String", # The field value to attribute. 676 "metric": "A String", # The metric to update. 677 }, 678 }, 679 ], 680 "notIns": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. 681 "A String", 682 ], 683 "ins": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries. 684 "A String", 685 ], 686 "action": "A String", # Required 687 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 688 "A String", 689 ], 690 "conditions": [ # Additional restrictions that must be met 691 { # A condition to be met. 692 "iam": "A String", # Trusted attributes supplied by the IAM system. 693 "svc": "A String", # Trusted attributes discharged by the service. 694 "value": "A String", # The object of the condition. Exactly one of these must be set. 695 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 696 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 697 "A String", 698 ], 699 "op": "A String", # An operator to apply the subject with. 700 }, 701 ], 702 "description": "A String", # Human-readable description of the rule. 703 }, 704 ], 705 "version": 42, # Version of the `Policy`. The default version is 0. 706 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. 707 # 708 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 709 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 710 { # Associates `members` with a `role`. 711 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 712 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 713 # 714 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 715 # 716 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 717 # 718 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. 719 # 720 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 721 # 722 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 723 # 724 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 725 "A String", 726 ], 727 }, 728 ], 729 "iamOwned": True or False, 730 }</pre> 731</div> 732 733<div class="method"> 734 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 735 <pre>Returns permissions that a caller has on the specified resource. 736 737Args: 738 project: string, Project ID for this request. (required) 739 resource: string, Name of the resource for this request. (required) 740 body: object, The request body. (required) 741 The object takes the form of: 742 743{ 744 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 745 "A String", 746 ], 747 } 748 749 750Returns: 751 An object of the form: 752 753 { 754 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 755 "A String", 756 ], 757 }</pre> 758</div> 759 760</body></html>