Blame - docs/dyn/policytroubleshooter_v1beta.iam.html - platform/external/python/google-api-python-client

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

[diff] [blame]

93

"permission": "A String", # Required. The IAM permission to check for the specified member and resource.

94

#

95

# For a complete list of IAM permissions, see

96

# https://cloud.google.com/iam/help/permissions/reference.

97

#

98

# For a complete list of predefined IAM roles and the permissions in each

99

# role, see https://cloud.google.com/iam/help/roles/reference.

Bu Sun Kim

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

[diff] [blame]

100

"fullResourceName": "A String", # Required. The full resource name that identifies the resource. For example,

101

# `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.

102

#

103

# For examples of full resource names for Google Cloud services, see

104

# https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

Bu Sun Kim

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

[diff] [blame^]

105

"principal": "A String", # Required. The member, or principal, whose access you want to check, in the form of

106

# the email address that represents that member. For example,

107

# `alice@example.com` or

108

# `my-service-account@my-project.iam.gserviceaccount.com`.

109

#

110

# The member must be a Google Account or a service account. Other types of

111

# members are not supported.

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

122

123

{ # Response for TroubleshootIamPolicy.

124

"explainedPolicies": [ # List of IAM policies that were evaluated to check the member's permissions,

125

# with annotations to indicate how each policy contributed to the final

126

# result.

127

#

128

# The list of policies can include the policy for the resource itself. It can

129

# also include policies that are inherited from higher levels of the resource

130

# hierarchy, including the organization, the folder, and the project.

131

#

132

# To learn more about the resource hierarchy, see

133

# https://cloud.google.com/iam/help/resource-hierarchy.

134

{ # Details about how a specific IAM Policy contributed

135

# to the access check.

Bu Sun Kim

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

[diff] [blame^]

136

"relevance": "A String", # The relevance of this policy to the overall determination in the

137

# TroubleshootIamPolicyResponse.

138

#

139

# If the sender of the request does not have access to the policy, this field

140

# is omitted.

Bu Sun Kim

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

[diff] [blame]

141

"access": "A String", # Indicates whether _this policy_ provides the specified permission to the

142

# specified member for the specified resource.

143

#

144

# This field does _not_ indicate whether the member actually has the

145

# permission for the resource. There might be another policy that overrides

146

# this policy. To determine whether the member actually has the permission,

147

# use the `access` field in the

148

# TroubleshootIamPolicyResponse.

Bu Sun Kim

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

[diff] [blame]

149

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # The IAM policy attached to the resource.

150

#

151

# If the sender of the request does not have access to the policy, this field

152

# is empty.

153

# controls for Google Cloud resources.

154

#

155

#

156

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

157

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

158

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

159

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

160

# custom role.

161

#

162

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

163

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

164

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

165

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

166

# resources support conditions in their IAM policies, see the

167

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

#

# **JSON example:**

#

# {

# "bindings": [

# {

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

175

# "members": [

176

# "user:mike@example.com",

177

# "group:admins@example.com",

178

# "domain:google.com",

179

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

# ]

# },

# {

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

184

# "members": [

185

# "user:eve@example.com"

186

# ],

187

# "condition": {

188

# "title": "expirable access",

189

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

190

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

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

203

# - group:admins@example.com

204

# - domain:google.com

205

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

206

# role: roles/resourcemanager.organizationAdmin

207

# - members:

208

# - user:eve@example.com

209

# role: roles/resourcemanager.organizationViewer

210

# condition:

211

# title: expirable access

212

# description: Does not grant access after Sep 2020

213

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

214

# - etag: BwWWja0YfJA=

215

# - version: 3

216

#

217

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

218

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

Bu Sun Kim

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

[diff] [blame]

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

#

227

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

228

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

229

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

230

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

Bu Sun Kim

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

[diff] [blame^]

231

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

232

{ # Specifies the audit configuration for a service.

233

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

234

# identities, if any, are exempted from logging.

235

# An AuditConfig must have one or more AuditLogConfigs.

236

#

237

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

238

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

239

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

240

# AuditLogConfig are exempted.

241

#

242

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

248

# "audit_log_configs": [

249

# {

250

# "log_type": "DATA_READ",

251

# "exempted_members": [

252

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

257

# },

258

# {

259

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

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

265

# "audit_log_configs": [

266

# {

267

# "log_type": "DATA_READ"

268

# },

269

# {

270

# "log_type": "DATA_WRITE",

271

# "exempted_members": [

272

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

281

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

282

# aliya@example.com from DATA_WRITE logging.

283

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

284

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

285

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

286

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

287

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

# Example:

#

# {

# "audit_log_configs": [

292

# {

293

# "log_type": "DATA_READ",

294

# "exempted_members": [

295

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

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

305

# jose@example.com from DATA_READ logging.

306

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

307

# permission.

308

# Follows the same format of Binding.members.

309

"A String",

310

],

311

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

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

316

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

317

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

318

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

319

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

Bu Sun Kim

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

[diff] [blame^]

320

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

321

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

Bu Sun Kim

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

[diff] [blame]

322

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

323

#

324

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

325

# current request.

326

#

327

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

328

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

329

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

330

#

331

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

332

# [IAM

333

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

334

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

335

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

336

#

337

# Example (Comparison):

338

#

339

# title: "Summary size limit"

340

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

341

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

342

#

343

# Example (Equality):

344

#

345

# title: "Requestor is owner"

346

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

347

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

#

# Example (Logic):

#

# title: "Public documents"

352

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

353

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

354

#

355

# Example (Data Manipulation):

356

#

357

# title: "Notification string"

358

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

359

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

360

#

361

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

362

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

363

# documentation for additional information.

364

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

365

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

Bu Sun Kim

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

[diff] [blame^]

366

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

367

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

368

# expression.

Bu Sun Kim

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

[diff] [blame]

369

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

370

# syntax.

371

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

372

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

Bu Sun Kim

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

[diff] [blame]

373

},

374

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

375

# `members` can have the following values:

376

#

377

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

378

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

379

#

380

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

381

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

382

#

383

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

384

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

385

#

386

#

387

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

388

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

389

#

390

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

391

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

392

#

393

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

394

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

395

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

396

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

397

# retains the role in the binding.

398

#

399

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

400

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

401

# deleted. For example,

402

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

403

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

404

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

405

# role in the binding.

406

#

407

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

408

# identifier) representing a Google group that has been recently

409

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

410

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

411

# recovered group retains the role in the binding.

412

#

413

#

414

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

415

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

416

#

417

"A String",

418

],

Bu Sun Kim

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

[diff] [blame]

419

},

420

],

Bu Sun Kim

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

[diff] [blame]

421

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

422

#

423

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

424

# are rejected.

425

#

426

# Any operation that affects conditional role bindings must specify version

427

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

428

#

429

# * Getting a policy that includes a conditional role binding

430

# * Adding a conditional role binding to a policy

431

# * Changing a conditional role binding in a policy

432

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

433

# that includes conditions

434

#

435

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

436

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

437

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

438

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

439

#

440

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

441

# specify any valid version or leave the field unset.

442

#

443

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

444

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

Bu Sun Kim

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

[diff] [blame]

445

},

Bu Sun Kim

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

[diff] [blame^]

446

"bindingExplanations": [ # Details about how each binding in the policy affects the member's ability,

447

# or inability, to use the permission for the resource.

448

#

449

# If the sender of the request does not have access to the policy, this field

450

# is omitted.

451

{ # Details about how a binding in a policy affects a member's ability to use a

452

# permission.

453

"rolePermissionRelevance": "A String", # The relevance of the permission's existence, or nonexistence, in the role

454

# to the overall determination for the entire policy.

455

"role": "A String", # The role that this binding grants. For example,

456

# `roles/compute.serviceAgent`.

457

#

458

# For a complete list of predefined IAM roles, as well as the permissions in

459

# each role, see https://cloud.google.com/iam/help/roles/reference.

460

"access": "A String", # Indicates whether _this binding_ provides the specified permission to the

461

# specified member for the specified resource.

462

#

463

# This field does _not_ indicate whether the member actually has the

464

# permission for the resource. There might be another binding that overrides

465

# this binding. To determine whether the member actually has the permission,

466

# use the `access` field in the

467

# TroubleshootIamPolicyResponse.

468

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition expression that prevents access unless the expression evaluates

469

# to `true`.

470

#

471

# To learn about IAM Conditions, see

472

# http://cloud.google.com/iam/help/conditions/overview.

473

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

474

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

475

#

476

# Example (Comparison):

477

#

478

# title: "Summary size limit"

479

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

480

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

481

#

482

# Example (Equality):

483

#

484

# title: "Requestor is owner"

485

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

486

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

#

# Example (Logic):

#

# title: "Public documents"

491

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

492

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

493

#

494

# Example (Data Manipulation):

495

#

496

# title: "Notification string"

497

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

498

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

499

#

500

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

501

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

502

# documentation for additional information.

503

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

504

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

505

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

506

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

507

# expression.

508

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

509

# syntax.

510

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

511

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

512

},

513

"relevance": "A String", # The relevance of this binding to the overall determination for the entire

514

# policy.

515

"memberships": { # Indicates whether each member in the binding includes the member specified

516

# in the request, either directly or indirectly. Each key identifies a member

517

# in the binding, and each value indicates whether the member in the binding

518

# includes the member in the request.

519

#

520

# For example, suppose that a binding includes the following members:

521

#

522

# * `user:alice@example.com`

523

# * `group:product-eng@example.com`

524

#

525

# You want to troubleshoot access for `user:bob@example.com`. This user is a

526

# member of the group `group:product-eng@example.com`.

527

#

528

# For the first member in the binding, the key is `user:alice@example.com`,

529

# and the `membership` field in the value is set to

530

# `MEMBERSHIP_NOT_INCLUDED`.

531

#

532

# For the second member in the binding, the key is

533

# `group:product-eng@example.com`, and the `membership` field in the value is

534

# set to `MEMBERSHIP_INCLUDED`.

535

"a_key": { # Details about whether the binding includes the member.

536

"relevance": "A String", # The relevance of the member's status to the overall determination for the

537

# binding.

538

"membership": "A String", # Indicates whether the binding includes the member.

539

},

540

},

541

"rolePermission": "A String", # Indicates whether the role granted by this binding contains the specified

# permission.

},

],

"fullResourceName": "A String", # The full resource name that identifies the resource. For example,

546

# `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.

547

#

548

# If the sender of the request does not have access to the policy, this field

549

# is omitted.

550

#

551

# For examples of full resource names for Google Cloud services, see

552

# https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

Bu Sun Kim