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.

Bu Sun Kim

6502091

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

[diff] [blame]

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

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

101

#

102

# For a complete list of IAM permissions, see

103

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

104

#

105

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

106

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

107

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

108

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

109

#

110

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

111

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

Bu Sun Kim

6502091

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

6502091

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

[diff] [blame]

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.

144

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

145

# TroubleshootIamPolicyResponse.

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

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

150

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

151

#

152

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

153

# is omitted.

154

#

155

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

156

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

157

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

158

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

159

#

160

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

161

# is omitted.

162

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

163

# permission.

164

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

165

# `roles/compute.serviceAgent`.

166

#

167

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

168

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

169

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

170

# permission.

171

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

172

# to `true`.

173

#

174

# To learn about IAM Conditions, see

175

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

176

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

177

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

178

#

179

# Example (Comparison):

180

#

181

# title: "Summary size limit"

182

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

183

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

184

#

185

# Example (Equality):

186

#

187

# title: "Requestor is owner"

188

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

189

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

#

# Example (Logic):

#

# title: "Public documents"

194

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

195

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

196

#

197

# Example (Data Manipulation):

198

#

199

# title: "Notification string"

200

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

201

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

202

#

203

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

204

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

205

# documentation for additional information.

206

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

207

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

208

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

209

# syntax.

210

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

211

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

212

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

213

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

214

# expression.

215

},

216

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

217

# to the overall determination for the entire policy.

218

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

219

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

220

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

221

# includes the member in the request.

222

#

223

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

224

#

225

# * `user:alice@example.com`

226

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

227

#

228

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

229

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

230

#

231

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

232

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

233

# `MEMBERSHIP_NOT_INCLUDED`.

234

#

235

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

236

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

237

# set to `MEMBERSHIP_INCLUDED`.

238

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

239

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

240

# binding.

241

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

242

},

243

},

244

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

245

# specified member for the specified resource.

246

#

247

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

248

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

249

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

250

# use the `access` field in the

251

# TroubleshootIamPolicyResponse.

252

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

253

# policy.

254

},

255

],

Bu Sun Kim

6502091

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

[diff] [blame]

256

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

257

#

258

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

259

# is empty.

260

# controls for Google Cloud resources.

261

#

262

#

263

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

264

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

265

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

266

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

267

# custom role.

268

#

269

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

270

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

271

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

272

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

273

# resources support conditions in their IAM policies, see the

274

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

#

# **JSON example:**

#

# {

# "bindings": [

# {

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

282

# "members": [

283

# "user:mike@example.com",

284

# "group:admins@example.com",

285

# "domain:google.com",

286

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

# ]

# },

# {

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

291

# "members": [

292

# "user:eve@example.com"

293

# ],

294

# "condition": {

295

# "title": "expirable access",

296

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

297

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

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

310

# - group:admins@example.com

311

# - domain:google.com

312

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

313

# role: roles/resourcemanager.organizationAdmin

314

# - members:

315

# - user:eve@example.com

316

# role: roles/resourcemanager.organizationViewer

317

# condition:

318

# title: expirable access

319

# description: Does not grant access after Sep 2020

320

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

321

# - etag: BwWWja0YfJA=

322

# - version: 3

323

#

324

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

325

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

#

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

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

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

389

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

390

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

391

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

392

# expression.

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",

],

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

440

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

441

},

442

],

Bu Sun Kim

6502091

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

[diff] [blame]

443

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

444

#

445

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

446

# are rejected.

447

#

448

# Any operation that affects conditional role bindings must specify version

449

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

450

#

451

# * Getting a policy that includes a conditional role binding

452

# * Adding a conditional role binding to a policy

453

# * Changing a conditional role binding in a policy

454

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

455

# that includes conditions

456

#

457

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

458

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

459

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

460

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

461

#

462

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

463

# specify any valid version or leave the field unset.

464

#

465

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

466

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

467

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

468

{ # Specifies the audit configuration for a service.

469

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

470

# identities, if any, are exempted from logging.

471

# An AuditConfig must have one or more AuditLogConfigs.

472

#

473

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

474

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

475

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

476

# AuditLogConfig are exempted.

477

#

478

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

484

# "audit_log_configs": [

485

# {

486

# "log_type": "DATA_READ",

487

# "exempted_members": [

488

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

493

# },

494

# {

495

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

501

# "audit_log_configs": [

502

# {

503

# "log_type": "DATA_READ",

504

# },

505

# {

506

# "log_type": "DATA_WRITE",

507

# "exempted_members": [

508

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

517

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

518

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

6502091

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

[diff] [blame]

519

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

520

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

# Example:

#

# {

# "audit_log_configs": [

525

# {

526

# "log_type": "DATA_READ",

527

# "exempted_members": [

528

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

538

# jose@example.com from DATA_READ logging.

539

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

540

# permission.

541

# Follows the same format of Binding.members.

542

"A String",

543

],

544

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

545

},

546

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

547

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

548

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

549

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

Bu Sun Kim

6502091

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

[diff] [blame]

550

},

551

],

Bu Sun Kim

6502091

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

[diff] [blame]

552

},

Bu Sun Kim

6502091

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

[diff] [blame]

553

},

554

],

555

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