Blame - docs/dyn/policytroubleshooter_v1.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-07-22 17:02:09 -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.

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.

Bu Sun Kim

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

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

[diff] [blame]

144

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

145

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

146

#

147

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

148

# is omitted.

149

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

150

# permission.

Bu Sun Kim

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

[diff] [blame]

151

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

152

# `roles/compute.serviceAgent`.

153

#

154

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

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

157

# to the overall determination for the entire policy.

Bu Sun Kim

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

[diff] [blame^]

158

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

159

# permission.

160

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

161

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

162

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

163

# includes the member in the request.

164

#

165

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

166

#

167

# * `user:alice@example.com`

168

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

169

#

170

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

171

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

172

#

173

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

174

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

175

# `MEMBERSHIP_NOT_INCLUDED`.

176

#

177

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

178

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

179

# set to `MEMBERSHIP_INCLUDED`.

180

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

181

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

182

# binding.

183

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

184

},

185

},

Bu Sun Kim

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

[diff] [blame]

186

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

187

# specified member for the specified resource.

188

#

189

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

190

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

191

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

192

# use the `access` field in the

193

# TroubleshootIamPolicyResponse.

Bu Sun Kim

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

[diff] [blame^]

194

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

195

# policy.

Bu Sun Kim

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

[diff] [blame]

196

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

197

# to `true`.

198

#

199

# To learn about IAM Conditions, see

200

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

201

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

202

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

203

#

204

# Example (Comparison):

205

#

206

# title: "Summary size limit"

207

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

208

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

209

#

210

# Example (Equality):

211

#

212

# title: "Requestor is owner"

213

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

214

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

#

# Example (Logic):

#

# title: "Public documents"

219

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

220

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

221

#

222

# Example (Data Manipulation):

223

#

224

# title: "Notification string"

225

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

226

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

227

#

228

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

229

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

230

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

231

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

232

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

Bu Sun Kim

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

[diff] [blame]

233

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

234

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

235

# expression.

Bu Sun Kim

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

[diff] [blame]

236

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

237

# syntax.

Bu Sun Kim

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

[diff] [blame^]

238

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

239

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

Bu Sun Kim

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

[diff] [blame]

240

},

Bu Sun Kim

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

[diff] [blame]

241

},

242

],

Bu Sun Kim

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

[diff] [blame^]

243

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

244

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

245

#

246

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

247

# is omitted.

248

#

249

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

250

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

Bu Sun Kim

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

[diff] [blame]

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

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

[diff] [blame^]

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

#

329

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

330

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

331

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

332

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

333

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

334

#

335

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

336

# are rejected.

337

#

338

# Any operation that affects conditional role bindings must specify version

339

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

340

#

341

# * Getting a policy that includes a conditional role binding

342

# * Adding a conditional role binding to a policy

343

# * Changing a conditional role binding in a policy

344

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

345

# that includes conditions

346

#

347

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

348

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

349

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

350

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

351

#

352

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

353

# specify any valid version or leave the field unset.

354

#

355

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

356

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

Bu Sun Kim

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

[diff] [blame]

357

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

358

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

359

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

360

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

Bu Sun Kim

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

[diff] [blame]

361

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

362

# `members` can have the following values:

363

#

364

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

365

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

366

#

367

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

368

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

369

#

370

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

371

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

372

#

373

#

374

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

375

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

376

#

377

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

378

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

379

#

380

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

381

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

382

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

383

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

384

# retains the role in the binding.

385

#

386

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

387

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

388

# deleted. For example,

389

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

390

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

391

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

392

# role in the binding.

393

#

394

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

395

# identifier) representing a Google group that has been recently

396

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

397

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

398

# recovered group retains the role in the binding.

399

#

400

#

401

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

402

# 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.

407

#

408

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

409

# current request.

410

#

411

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

412

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

413

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

414

#

415

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

416

# [IAM

417

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

418

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

419

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

420

#

421

# Example (Comparison):

422

#

423

# title: "Summary size limit"

424

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

425

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

426

#

427

# Example (Equality):

428

#

429

# title: "Requestor is owner"

430

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

431

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

#

# Example (Logic):

#

# title: "Public documents"

436

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

437

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

438

#

439

# Example (Data Manipulation):

440

#

441

# title: "Notification string"

442

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

443

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

444

#

445

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

446

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

447

# documentation for additional information.

448

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

449

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

450

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

451

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

452

# expression.

Bu Sun Kim

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

[diff] [blame]

453

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

454

# syntax.

Bu Sun Kim

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

[diff] [blame^]

455

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

456

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

Bu Sun Kim

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

[diff] [blame]

457

},

Bu Sun Kim

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

[diff] [blame^]

458

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

459

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

Bu Sun Kim

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

[diff] [blame]

460

},

461

],

Bu Sun Kim

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

[diff] [blame]

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": [

# {

Bu Sun Kim

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

[diff] [blame^]

478

# "service": "allServices",

Bu Sun Kim

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

[diff] [blame]

479

# "audit_log_configs": [

480

# {

481

# "log_type": "DATA_READ",

482

# "exempted_members": [

483

# "user:jose@example.com"

484

# ]

485

# },

486

# {

Bu Sun Kim

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

[diff] [blame^]

487

# "log_type": "DATA_WRITE"

Bu Sun Kim

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

[diff] [blame]

488

# },

489

# {

Bu Sun Kim

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

[diff] [blame^]

490

# "log_type": "ADMIN_READ"

Bu Sun Kim

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

[diff] [blame]

# }

# ]

# },

# {

Bu Sun Kim

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

[diff] [blame^]

495

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

Bu Sun Kim

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

[diff] [blame]

496

# "audit_log_configs": [

497

# {

Bu Sun Kim

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

[diff] [blame^]

498

# "log_type": "DATA_READ"

Bu Sun Kim

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

[diff] [blame]

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

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

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"

527

# ]

528

# },

529

# {

Bu Sun Kim

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

[diff] [blame^]

530

# "log_type": "DATA_WRITE"

Bu Sun Kim

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

[diff] [blame]

# }

# ]

# }

#

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

536

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame^]

537

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

Bu Sun Kim

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

[diff] [blame]

538

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

539

# permission.

540

# Follows the same format of Binding.members.

541

"A String",

542

],

Bu Sun Kim

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

[diff] [blame]

543

},

544

],

Bu Sun Kim

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

[diff] [blame]

545

},

546

],

547

},

Bu Sun Kim

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

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

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

[diff] [blame]

553

},

554

],

Bu Sun Kim

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