Blame - docs/dyn/cloudasset_v1p1beta1.iamPolicies.html - platform/external/python/google-api-python-client

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # The IAM policy directly set on the given resource. Note that the original

147

# IAM policy can contain multiple bindings. This only contains the bindings

148

# that match the given query. For queries that don't contain a constrain on

149

# policies (e.g. an empty query), this contains all the bindings.

150

# controls for Google Cloud resources.

151

#

152

#

153

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

154

# `members` to a single `role`. Members can be user accounts, service accounts,

155

# Google groups, and domains (such as G Suite). A `role` is a named list of

156

# permissions; each `role` can be an IAM predefined role or a user-created

157

# custom role.

158

#

159

# Optionally, a `binding` can specify a `condition`, which is a logical

160

# expression that allows access to a resource only if the expression evaluates

161

# to `true`. A condition can add constraints based on attributes of the

162

# request, the resource, or both.

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

170

# "members": [

171

# "user:mike@example.com",

172

# "group:admins@example.com",

173

# "domain:google.com",

174

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

179

# "members": ["user:eve@example.com"],

180

# "condition": {

181

# "title": "expirable access",

182

# "description": "Does not grant access after Sep 2020",

183

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

196

# - group:admins@example.com

197

# - domain:google.com

198

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

199

# role: roles/resourcemanager.organizationAdmin

200

# - members:

201

# - user:eve@example.com

202

# role: roles/resourcemanager.organizationViewer

203

# condition:

204

# title: expirable access

205

# description: Does not grant access after Sep 2020

206

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

207

# - etag: BwWWja0YfJA=

208

# - version: 3

209

#

210

# For a description of IAM and its features, see the

211

# [IAM documentation](https://cloud.google.com/iam/docs/).

212

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

213

# prevent simultaneous updates of a policy from overwriting each other.

214

# It is strongly suggested that systems make use of the `etag` in the

215

# read-modify-write cycle to perform policy updates in order to avoid race

216

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

217

# systems are expected to put that etag in the request to `setIamPolicy` to

218

# ensure that their change will be applied to the same version of the policy.

219

#

220

# **Important:** If you use IAM Conditions, you must include the `etag` field

221

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

222

# you to overwrite a version `3` policy with a version `1` policy, and all of

223

# the conditions in the version `3` policy are lost.

224

"version": 42, # Specifies the format of the policy.

225

#

226

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

227

# are rejected.

228

#

229

# Any operation that affects conditional role bindings must specify version

230

# `3`. This requirement applies to the following operations:

231

#

232

# * Getting a policy that includes a conditional role binding

233

# * Adding a conditional role binding to a policy

234

# * Changing a conditional role binding in a policy

235

# * Removing any role binding, with or without a condition, from a policy

236

# that includes conditions

237

#

238

# **Important:** If you use IAM Conditions, you must include the `etag` field

239

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

240

# you to overwrite a version `3` policy with a version `1` policy, and all of

241

# the conditions in the version `3` policy are lost.

242

#

243

# If a policy does not include any conditions, operations on that policy may

244

# specify any valid version or leave the field unset.

245

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

246

{ # Specifies the audit configuration for a service.

247

# The configuration determines which permission types are logged, and what

248

# identities, if any, are exempted from logging.

249

# An AuditConfig must have one or more AuditLogConfigs.

250

#

251

# If there are AuditConfigs for both `allServices` and a specific service,

252

# the union of the two AuditConfigs is used for that service: the log_types

253

# specified in each AuditConfig are enabled, and the exempted_members in each

254

# AuditLogConfig are exempted.

255

#

256

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

262

# "audit_log_configs": [

263

# {

264

# "log_type": "DATA_READ",

265

# "exempted_members": [

266

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

271

# },

272

# {

273

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

279

# "audit_log_configs": [

280

# {

281

# "log_type": "DATA_READ",

282

# },

283

# {

284

# "log_type": "DATA_WRITE",

285

# "exempted_members": [

286

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

295

# logging. It also exempts jose@example.com from DATA_READ logging, and

296

# aliya@example.com from DATA_WRITE logging.

297

"service": "A String", # Specifies a service that will be enabled for audit logging.

298

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

299

# `allServices` is a special value that covers all services.

300

"auditLogConfigs": [ # The configuration for logging of each type of permission.

301

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

306

# {

307

# "log_type": "DATA_READ",

308

# "exempted_members": [

309

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

319

# jose@example.com from DATA_READ logging.

320

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

321

# permission.

322

# Follows the same format of Binding.members.

323

"A String",

324

],

325

"logType": "A String", # The log type that this config enables.

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

331

# `condition` that determines how and when the `bindings` are applied. Each

332

# of the `bindings` must contain at least one member.

333

{ # Associates `members` with a `role`.

334

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

335

# NOTE: An unsatisfied condition will not allow user access via current

336

# binding. Different bindings, including their conditions, are examined

337

# independently.

338

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

339

# are documented at https://github.com/google/cel-spec.

340

#

341

# Example (Comparison):

342

#

343

# title: "Summary size limit"

344

# description: "Determines if a summary is less than 100 chars"

345

# expression: "document.summary.size() < 100"

346

#

347

# Example (Equality):

348

#

349

# title: "Requestor is owner"

350

# description: "Determines if requestor is the document owner"

351

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

356

# description: "Determine whether the document should be publicly visible"

357

# expression: "document.type != 'private' && document.type != 'internal'"

358

#

359

# Example (Data Manipulation):

360

#

361

# title: "Notification string"

362

# description: "Create a notification string with a timestamp."

363

# expression: "'New message received at ' + string(document.create_time)"

364

#

365

# The exact variables and functions that may be referenced within an expression

366

# are determined by the service that evaluates it. See the service

367

# documentation for additional information.

368

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

369

# its purpose. This can be used e.g. in UIs which allow to enter the

370

# expression.

371

"location": "A String", # Optional. String indicating the location of the expression for error

372

# reporting, e.g. a file name and a position in the file.

373

"description": "A String", # Optional. Description of the expression. This is a longer text which

374

# describes the expression, e.g. when hovered over it in a UI.

375

"expression": "A String", # Textual representation of an expression in Common Expression Language

376

# syntax.

377

},

378

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

379

# `members` can have the following values:

380

#

381

# * `allUsers`: A special identifier that represents anyone who is

382

# on the internet; with or without a Google account.

383

#

384

# * `allAuthenticatedUsers`: A special identifier that represents anyone

385

# who is authenticated with a Google account or a service account.

386

#

387

# * `user:{emailid}`: An email address that represents a specific Google

388

# account. For example, `alice@example.com` .

389

#

390

#

391

# * `serviceAccount:{emailid}`: An email address that represents a service

392

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

393

#

394

# * `group:{emailid}`: An email address that represents a Google group.

395

# For example, `admins@example.com`.

396

#

397

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

398

# identifier) representing a user that has been recently deleted. For

399

# example, `alice@example.com?uid=123456789012345678901`. If the user is

400

# recovered, this value reverts to `user:{emailid}` and the recovered user

401

# retains the role in the binding.

402

#

403

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

404

# unique identifier) representing a service account that has been recently

405

# deleted. For example,

406

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

407

# If the service account is undeleted, this value reverts to

408

# `serviceAccount:{emailid}` and the undeleted service account retains the

409

# role in the binding.

410

#

411

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

412

# identifier) representing a Google group that has been recently

413

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

414

# the group is recovered, this value reverts to `group:{emailid}` and the

415

# recovered group retains the role in the binding.

416

#

417

#

418

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

419

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

424

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

},

],

},

},

],

"nextPageToken": "A String", # Set if there are more results than those appearing in this response; to get

431

# the next set of results, call this method again, using this value as the

# `page_token`.

}</pre>

</div>

<code class="details" id="searchAll_next">searchAll_next(previous_request, previous_response)</code>

438

<pre>Retrieves the next page of results.

439

440

Args:

441

previous_request: The request for the previous page. (required)

442

previous_response: The response from the request for the previous page. (required)

443

444

Returns:

445

A request object that you can call 'execute()' on to request the next

446

page. Returns None if there are no more items in the collection.

</pre>

</div>

</body></html>