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

148

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

149

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

150

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

151

# controls for Google Cloud resources.

152

#

153

#

154

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

155

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

156

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

157

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

158

# custom role.

159

#

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

160

# For some types of Google Cloud resources, a `binding` can also specify a

161

# `condition`, which is a logical expression that allows access to a resource

162

# only if the expression evaluates to `true`. A condition can add constraints

163

# based on attributes of the request, the resource, or both. To learn which

164

# resources support conditions in their IAM policies, see the

165

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

#

# **JSON example:**

#

# {

# "bindings": [

# {

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

173

# "members": [

174

# "user:mike@example.com",

175

# "group:admins@example.com",

176

# "domain:google.com",

177

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

# ]

# },

# {

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

182

# "members": [

183

# "user:eve@example.com"

184

# ],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

185

# "condition": {

186

# "title": "expirable access",

187

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

188

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

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

201

# - group:admins@example.com

202

# - domain:google.com

203

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

204

# role: roles/resourcemanager.organizationAdmin

205

# - members:

206

# - user:eve@example.com

207

# role: roles/resourcemanager.organizationViewer

208

# condition:

209

# title: expirable access

210

# description: Does not grant access after Sep 2020

211

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

212

# - etag: BwWWja0YfJA=

213

# - version: 3

214

#

215

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

216

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

217

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

218

#

219

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

220

# are rejected.

221

#

222

# Any operation that affects conditional role bindings must specify version

223

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

224

#

225

# * Getting a policy that includes a conditional role binding

226

# * Adding a conditional role binding to a policy

227

# * Changing a conditional role binding in a policy

228

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

229

# that includes conditions

230

#

231

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

232

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

233

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

234

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

235

#

236

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

237

# specify any valid version or leave the field unset.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

238

#

239

# To learn which resources support conditions in their IAM policies, see the

240

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

241

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

242

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

243

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

244

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

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

245

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

246

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

247

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

248

#

249

# If the condition evaluates to `true`, then this binding applies to the

250

# current request.

251

#

252

# If the condition evaluates to `false`, then this binding does not apply to

253

# the current request. However, a different role binding might grant the same

254

# role to one or more of the members in this binding.

255

#

256

# To learn which resources support conditions in their IAM policies, see the

257

# [IAM

258

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

259

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

260

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

261

#

262

# Example (Comparison):

263

#

264

# title: "Summary size limit"

265

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

266

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

267

#

268

# Example (Equality):

269

#

270

# title: "Requestor is owner"

271

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

272

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

#

# Example (Logic):

#

# title: "Public documents"

277

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

278

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

279

#

280

# Example (Data Manipulation):

281

#

282

# title: "Notification string"

283

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

284

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

285

#

286

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

287

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

288

# documentation for additional information.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

289

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

290

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

291

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

292

# syntax.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

293

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

294

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

295

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

296

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

297

# expression.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

298

},

299

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

300

# `members` can have the following values:

301

#

302

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

303

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

304

#

305

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

306

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

307

#

308

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

309

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

310

#

311

#

312

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

313

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

314

#

315

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

316

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

317

#

318

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

319

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

320

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

321

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

322

# retains the role in the binding.

323

#

324

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

325

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

326

# deleted. For example,

327

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

328

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

329

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

330

# role in the binding.

331

#

332

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

333

# identifier) representing a Google group that has been recently

334

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

335

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

336

# recovered group retains the role in the binding.

337

#

338

#

339

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

340

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

341

#

342

"A String",

343

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

344

},

345

],

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

346

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

347

{ # Specifies the audit configuration for a service.

348

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

349

# identities, if any, are exempted from logging.

350

# An AuditConfig must have one or more AuditLogConfigs.

351

#

352

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

353

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

354

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

355

# AuditLogConfig are exempted.

356

#

357

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

363

# "audit_log_configs": [

364

# {

365

# "log_type": "DATA_READ",

366

# "exempted_members": [

367

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

372

# },

373

# {

374

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

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

380

# "audit_log_configs": [

381

# {

382

# "log_type": "DATA_READ"

383

# },

384

# {

385

# "log_type": "DATA_WRITE",

386

# "exempted_members": [

387

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

396

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

397

# aliya@example.com from DATA_WRITE logging.

398

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

399

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

400

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

401

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

402

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

# Example:

#

# {

# "audit_log_configs": [

407

# {

408

# "log_type": "DATA_READ",

409

# "exempted_members": [

410

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

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

420

# jose@example.com from DATA_READ logging.

421

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

422

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

423

# permission.

424

# Follows the same format of Binding.members.

"A String",

],

},

],

},

],

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

432

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

433

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

434

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

435

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

436

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

437

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

438

#

439

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

440

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

441

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

442

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

443

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

444

"resource": "A String", # The [full resource

445

# name](https://cloud.google.com/apis/design/resource_names#full_resource_name)

446

# of the resource associated with this IAM policy.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

447

},

448

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

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

454

<pre>Retrieves the next page of results.

455

456

Args:

457

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

458

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

459

460

Returns:

461

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

462

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

</pre>

</div>

</body></html>