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