Blame - docs/dyn/policytroubleshooter_v1.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

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

94

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

95

# `alice@example.com` or

96

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

97

#

98

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

99

# members are not supported.

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.

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.

Bu Sun Kim

6502091

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

[diff] [blame]

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

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

137

# specified member for the specified resource.

138

#

139

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

140

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

141

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

142

# use the `access` field in the

143

# TroubleshootIamPolicyResponse.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

144

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

145

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

Bu Sun Kim

6502091

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

[diff] [blame]

146

#

147

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

148

# is omitted.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

149

#

150

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

151

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

Bu Sun Kim

6502091

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

[diff] [blame]

152

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

153

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

154

#

155

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

156

# is omitted.

157

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

158

# permission.

Bu Sun Kim

6502091

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

[diff] [blame]

159

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

160

# `roles/compute.serviceAgent`.

161

#

162

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

163

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

164

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

165

# permission.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

166

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

167

# to the overall determination for the entire policy.

168

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

169

# specified member for the specified resource.

170

#

171

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

172

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

173

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

174

# use the `access` field in the

175

# TroubleshootIamPolicyResponse.

Bu Sun Kim

6502091

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

[diff] [blame]

176

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

177

# to `true`.

178

#

179

# To learn about IAM Conditions, see

180

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

181

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

182

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

183

#

184

# Example (Comparison):

185

#

186

# title: "Summary size limit"

187

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

188

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

189

#

190

# Example (Equality):

191

#

192

# title: "Requestor is owner"

193

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

194

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

#

# Example (Logic):

#

# title: "Public documents"

199

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

200

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

201

#

202

# Example (Data Manipulation):

203

#

204

# title: "Notification string"

205

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

206

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

207

#

208

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

209

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

210

# documentation for additional information.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

211

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

212

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

Bu Sun Kim

6502091

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

[diff] [blame]

213

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

214

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

215

# expression.

216

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

217

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

218

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

219

# syntax.

Bu Sun Kim

6502091

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

[diff] [blame]

220

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

221

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

222

# policy.

223

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

224

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

225

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

226

# includes the member in the request.

Bu Sun Kim

6502091

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

[diff] [blame]

227

#

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

228

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

229

#

230

# * `user:alice@example.com`

231

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

232

#

233

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

234

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

235

#

236

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

237

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

238

# `MEMBERSHIP_NOT_INCLUDED`.

239

#

240

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

241

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

242

# set to `MEMBERSHIP_INCLUDED`.

243

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

244

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

245

# binding.

246

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

247

},

248

},

Bu Sun Kim

6502091

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

[diff] [blame]

249

},

250

],

251

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

252

#

253

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

254

# is empty.

255

# controls for Google Cloud resources.

256

#

257

#

258

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

259

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

260

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

261

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

262

# custom role.

263

#

264

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

265

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

266

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

267

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

268

# resources support conditions in their IAM policies, see the

269

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

#

# **JSON example:**

#

# {

# "bindings": [

# {

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

277

# "members": [

278

# "user:mike@example.com",

279

# "group:admins@example.com",

280

# "domain:google.com",

281

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

# ]

# },

# {

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

286

# "members": [

287

# "user:eve@example.com"

288

# ],

289

# "condition": {

290

# "title": "expirable access",

291

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

292

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

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

305

# - group:admins@example.com

306

# - domain:google.com

307

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

308

# role: roles/resourcemanager.organizationAdmin

309

# - members:

310

# - user:eve@example.com

311

# role: roles/resourcemanager.organizationViewer

312

# condition:

313

# title: expirable access

314

# description: Does not grant access after Sep 2020

315

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

316

# - etag: BwWWja0YfJA=

317

# - version: 3

318

#

319

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

320

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

# `members` can have the following values:

329

#

330

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

331

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

332

#

333

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

334

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

335

#

336

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

337

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

338

#

339

#

340

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

341

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

342

#

343

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

344

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

345

#

346

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

347

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

348

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

349

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

350

# retains the role in the binding.

351

#

352

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

353

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

354

# deleted. For example,

355

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

356

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

357

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

358

# role in the binding.

359

#

360

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

361

# identifier) representing a Google group that has been recently

362

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

363

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

364

# recovered group retains the role in the binding.

365

#

366

#

367

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

368

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

#

"A String",

],

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

373

#

374

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

375

# current request.

376

#

377

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

378

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

379

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

380

#

381

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

382

# [IAM

383

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

384

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

385

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

386

#

387

# Example (Comparison):

388

#

389

# title: "Summary size limit"

390

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

391

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

392

#

393

# Example (Equality):

394

#

395

# title: "Requestor is owner"

396

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

397

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

#

# Example (Logic):

#

# title: "Public documents"

402

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

403

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

404

#

405

# Example (Data Manipulation):

406

#

407

# title: "Notification string"

408

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

409

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

410

#

411

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

412

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

413

# documentation for additional information.

414

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

415

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

416

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

417

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

418

# expression.

419

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

420

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

421

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

# syntax.

},

},

],

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

427

#

428

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

429

# are rejected.

430

#

431

# Any operation that affects conditional role bindings must specify version

432

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

433

#

434

# * Getting a policy that includes a conditional role binding

435

# * Adding a conditional role binding to a policy

436

# * Changing a conditional role binding in a policy

437

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

438

# that includes conditions

439

#

440

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

441

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

442

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

443

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

444

#

445

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

446

# specify any valid version or leave the field unset.

447

#

448

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

449

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

Bu Sun Kim

6502091

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

[diff] [blame]

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

#

458

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

459

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

460

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

461

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

462

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

463

{ # Specifies the audit configuration for a service.

464

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

465

# identities, if any, are exempted from logging.

466

# An AuditConfig must have one or more AuditLogConfigs.

467

#

468

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

469

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

470

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

471

# AuditLogConfig are exempted.

472

#

473

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

479

# "audit_log_configs": [

480

# {

481

# "log_type": "DATA_READ",

482

# "exempted_members": [

483

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

488

# },

489

# {

490

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

496

# "audit_log_configs": [

497

# {

498

# "log_type": "DATA_READ",

499

# },

500

# {

501

# "log_type": "DATA_WRITE",

502

# "exempted_members": [

503

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

512

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

513

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

514

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

515

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

516

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

Bu Sun Kim

6502091

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

[diff] [blame]

517

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

518

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

# Example:

#

# {

# "audit_log_configs": [

523

# {

524

# "log_type": "DATA_READ",

525

# "exempted_members": [

526

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

536

# jose@example.com from DATA_READ logging.

537

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

538

# permission.

539

# Follows the same format of Binding.members.

540

"A String",

541

],

542

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

543

},

544

],

Bu Sun Kim

6502091

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

[diff] [blame]

545

},

546

],

547

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

548

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

549

# TroubleshootIamPolicyResponse.

Bu Sun Kim

6502091

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

[diff] [blame]

550

#

551

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

552

# is omitted.

Bu Sun Kim

6502091

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

[diff] [blame]

553

},

554

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

555

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

556

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

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

</body></html>