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

"accessTuple": { # Information about the member, resource, and permission to check. # The information to use for checking whether a member has a permission for a

92

# resource.

93

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

94

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

95

#

96

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

97

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

98

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

99

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

100

# `alice@example.com` or

101

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

102

#

103

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

104

# members are not supported.

105

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

106

#

107

# For a complete list of IAM permissions, see

108

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

109

#

110

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

111

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

},

}

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.

136

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

137

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

138

#

139

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

140

# is omitted.

141

#

142

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

143

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

144

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

145

# specified member for the specified resource.

146

#

147

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

148

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

149

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

150

# use the `access` field in the

151

# TroubleshootIamPolicyResponse.

152

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

153

# TroubleshootIamPolicyResponse.

154

#

155

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

156

# is omitted.

157

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

158

#

159

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

160

# is empty.

161

# controls for Google Cloud resources.

162

#

163

#

164

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

165

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

166

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

167

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

168

# custom role.

169

#

170

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

171

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

172

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

173

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

174

# resources support conditions in their IAM policies, see the

175

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

#

# **JSON example:**

#

# {

# "bindings": [

# {

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

183

# "members": [

184

# "user:mike@example.com",

185

# "group:admins@example.com",

186

# "domain:google.com",

187

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

# ]

# },

# {

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

192

# "members": [

193

# "user:eve@example.com"

194

# ],

195

# "condition": {

196

# "title": "expirable access",

197

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

198

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

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

211

# - group:admins@example.com

212

# - domain:google.com

213

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

214

# role: roles/resourcemanager.organizationAdmin

215

# - members:

216

# - user:eve@example.com

217

# role: roles/resourcemanager.organizationViewer

218

# condition:

219

# title: expirable access

220

# description: Does not grant access after Sep 2020

221

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

222

# - etag: BwWWja0YfJA=

223

# - version: 3

224

#

225

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

226

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

227

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

228

#

229

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

230

# are rejected.

231

#

232

# Any operation that affects conditional role bindings must specify version

233

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

234

#

235

# * Getting a policy that includes a conditional role binding

236

# * Adding a conditional role binding to a policy

237

# * Changing a conditional role binding in a policy

238

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

239

# that includes conditions

240

#

241

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

242

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

243

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

244

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

245

#

246

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

247

# specify any valid version or leave the field unset.

248

#

249

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

250

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

251

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

252

{ # Specifies the audit configuration for a service.

253

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

254

# identities, if any, are exempted from logging.

255

# An AuditConfig must have one or more AuditLogConfigs.

256

#

257

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

258

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

259

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

260

# AuditLogConfig are exempted.

261

#

262

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

268

# "audit_log_configs": [

269

# {

270

# "log_type": "DATA_READ",

271

# "exempted_members": [

272

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

277

# },

278

# {

279

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

285

# "audit_log_configs": [

286

# {

287

# "log_type": "DATA_READ",

288

# },

289

# {

290

# "log_type": "DATA_WRITE",

291

# "exempted_members": [

292

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

301

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

302

# aliya@example.com from DATA_WRITE logging.

303

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

304

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

305

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

306

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

307

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

# Example:

#

# {

# "audit_log_configs": [

312

# {

313

# "log_type": "DATA_READ",

314

# "exempted_members": [

315

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

325

# jose@example.com from DATA_READ logging.

326

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

327

# permission.

328

# Follows the same format of Binding.members.

329

"A String",

330

],

331

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

},

],

},

],

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

337

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

338

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

339

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

340

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

341

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

342

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

343

#

344

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

345

# current request.

346

#

347

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

348

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

349

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

350

#

351

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

352

# [IAM

353

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

354

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

355

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

356

#

357

# Example (Comparison):

358

#

359

# title: "Summary size limit"

360

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

361

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

362

#

363

# Example (Equality):

364

#

365

# title: "Requestor is owner"

366

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

367

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

#

# Example (Logic):

#

# title: "Public documents"

372

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

373

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

374

#

375

# Example (Data Manipulation):

376

#

377

# title: "Notification string"

378

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

379

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

380

#

381

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

382

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

383

# documentation for additional information.

384

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

385

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

386

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

387

# syntax.

388

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

389

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

390

# expression.

391

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

392

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

393

},

394

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

395

# `members` can have the following values:

396

#

397

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

398

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

399

#

400

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

401

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

402

#

403

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

404

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

405

#

406

#

407

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

408

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

409

#

410

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

411

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

412

#

413

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

414

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

415

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

416

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

417

# retains the role in the binding.

418

#

419

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

420

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

421

# deleted. For example,

422

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

423

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

424

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

425

# role in the binding.

426

#

427

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

428

# identifier) representing a Google group that has been recently

429

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

430

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

431

# recovered group retains the role in the binding.

432

#

433

#

434

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

435

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

#

"A String",

],

},

],

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

442

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

443

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

444

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

445

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

446

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

447

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

448

#

449

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

450

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

451

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

452

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

453

},

454

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

455

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

456

#

457

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

458

# is omitted.

459

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

460

# permission.

461

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

462

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

463

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

464

# includes the member in the request.

465

#

466

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

467

#

468

# * `user:alice@example.com`

469

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

470

#

471

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

472

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

473

#

474

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

475

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

476

# `MEMBERSHIP_NOT_INCLUDED`.

477

#

478

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

479

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

480

# set to `MEMBERSHIP_INCLUDED`.

481

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

482

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

483

# binding.

484

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

485

},

486

},

487

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

488

# permission.

489

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

490

# policy.

491

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

492

# `roles/compute.serviceAgent`.

493

#

494

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

495

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

496

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

497

# to the overall determination for the entire policy.

498

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

499

# to `true`.

500

#

501

# To learn about IAM Conditions, see

502

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

503

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

504

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

505

#

506

# Example (Comparison):

507

#

508

# title: "Summary size limit"

509

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

510

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

511

#

512

# Example (Equality):

513

#

514

# title: "Requestor is owner"

515

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

516

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

#

# Example (Logic):

#

# title: "Public documents"

521

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

522

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

523

#

524

# Example (Data Manipulation):

525

#

526

# title: "Notification string"

527

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

528

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

529

#

530

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

531

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

532

# documentation for additional information.

533

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

534

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

535

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

536

# syntax.

537

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

538

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

539

# expression.

540

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

541

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

542

},

543

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

544

# specified member for the specified resource.

545

#

546

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

547

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

548

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

549

# use the `access` field in the

550

# TroubleshootIamPolicyResponse.

},

],

},

],

"access": "A String", # Indicates whether the member has the specified permission for the specified

556

# resource, based on evaluating all of the applicable policies.

}</pre>

</div>

</body></html>