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.

124

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

125

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

126

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

127

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

128

# result.

129

#

130

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

131

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

132

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

133

#

134

# To learn more about the resource hierarchy, see

135

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

136

{ # Details about how a specific IAM Policy contributed

137

# to the access check.

138

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

139

# specified member for the specified resource.

140

#

141

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

142

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

143

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

144

# use the `access` field in the

145

# TroubleshootIamPolicyResponse.

146

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

147

# TroubleshootIamPolicyResponse.

148

#

149

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

150

# is omitted.

151

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

152

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

153

#

154

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

155

# is omitted.

156

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

157

# permission.

158

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

159

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

160

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

161

# includes the member in the request.

162

#

163

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

164

#

165

# * `user:alice@example.com`

166

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

167

#

168

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

169

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

170

#

171

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

172

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

173

# `MEMBERSHIP_NOT_INCLUDED`.

174

#

175

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

176

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

177

# set to `MEMBERSHIP_INCLUDED`.

178

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

179

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

180

# binding.

181

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

182

},

183

},

184

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

185

# policy.

186

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

187

# `roles/compute.serviceAgent`.

188

#

189

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

190

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

191

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

192

# permission.

193

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

194

# to `true`.

195

#

196

# To learn about IAM Conditions, see

197

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

198

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

199

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

200

#

201

# Example (Comparison):

202

#

203

# title: "Summary size limit"

204

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

205

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

206

#

207

# Example (Equality):

208

#

209

# title: "Requestor is owner"

210

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

211

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

#

# Example (Logic):

#

# title: "Public documents"

216

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

217

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

218

#

219

# Example (Data Manipulation):

220

#

221

# title: "Notification string"

222

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

223

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

224

#

225

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

226

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

227

# documentation for additional information.

228

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

229

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

230

# expression.

231

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

232

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

233

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

234

# syntax.

235

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

236

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

237

},

238

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

239

# to the overall determination for the entire policy.

240

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

241

# specified member for the specified resource.

242

#

243

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

244

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

245

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

246

# use the `access` field in the

247

# TroubleshootIamPolicyResponse.

248

},

249

],

250

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

251

#

252

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

253

# is empty.

254

# controls for Google Cloud resources.

255

#

256

#

257

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

258

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

259

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

260

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

261

# custom role.

262

#

263

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

264

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

265

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

266

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

267

# resources support conditions in their IAM policies, see the

268

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

#

# **JSON example:**

#

# {

# "bindings": [

# {

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

276

# "members": [

277

# "user:mike@example.com",

278

# "group:admins@example.com",

279

# "domain:google.com",

280

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

# ]

# },

# {

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

285

# "members": [

286

# "user:eve@example.com"

287

# ],

288

# "condition": {

289

# "title": "expirable access",

290

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

291

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

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

304

# - group:admins@example.com

305

# - domain:google.com

306

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

307

# role: roles/resourcemanager.organizationAdmin

308

# - members:

309

# - user:eve@example.com

310

# role: roles/resourcemanager.organizationViewer

311

# condition:

312

# title: expirable access

313

# description: Does not grant access after Sep 2020

314

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

315

# - etag: BwWWja0YfJA=

316

# - version: 3

317

#

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

#

328

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

329

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

330

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

331

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

332

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

333

{ # Specifies the audit configuration for a service.

334

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

335

# identities, if any, are exempted from logging.

336

# An AuditConfig must have one or more AuditLogConfigs.

337

#

338

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

339

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

340

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

341

# AuditLogConfig are exempted.

342

#

343

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

349

# "audit_log_configs": [

350

# {

351

# "log_type": "DATA_READ",

352

# "exempted_members": [

353

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

358

# },

359

# {

360

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

366

# "audit_log_configs": [

367

# {

368

# "log_type": "DATA_READ",

369

# },

370

# {

371

# "log_type": "DATA_WRITE",

372

# "exempted_members": [

373

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

382

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

383

# aliya@example.com from DATA_WRITE logging.

384

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

385

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

# Example:

#

# {

# "audit_log_configs": [

390

# {

391

# "log_type": "DATA_READ",

392

# "exempted_members": [

393

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

403

# jose@example.com from DATA_READ logging.

404

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

405

# permission.

406

# Follows the same format of Binding.members.

407

"A String",

408

],

409

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

410

},

411

],

412

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

413

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

414

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

415

},

416

],

417

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

418

#

419

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

420

# are rejected.

421

#

422

# Any operation that affects conditional role bindings must specify version

423

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

424

#

425

# * Getting a policy that includes a conditional role binding

426

# * Adding a conditional role binding to a policy

427

# * Changing a conditional role binding in a policy

428

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

429

# that includes conditions

430

#

431

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

432

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

433

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

434

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

435

#

436

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

437

# specify any valid version or leave the field unset.

438

#

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

#

449

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

450

# current request.

451

#

452

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

453

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

454

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

455

#

456

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

457

# [IAM

458

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

459

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

460

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

461

#

462

# Example (Comparison):

463

#

464

# title: "Summary size limit"

465

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

466

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

467

#

468

# Example (Equality):

469

#

470

# title: "Requestor is owner"

471

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

472

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

#

# Example (Logic):

#

# title: "Public documents"

477

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

478

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

479

#

480

# Example (Data Manipulation):

481

#

482

# title: "Notification string"

483

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

484

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

485

#

486

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

487

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

488

# documentation for additional information.

489

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

490

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

491

# expression.

492

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

493

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

494

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

495

# syntax.

496

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

497

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

498

},

499

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

500

# `members` can have the following values:

501

#

502

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

503

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

504

#

505

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

506

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

507

#

508

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

509

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

510

#

511

#

512

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

513

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

514

#

515

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

516

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

517

#

518

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

519

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

520

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

521

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

522

# retains the role in the binding.

523

#

524

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

525

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

526

# deleted. For example,

527

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

528

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

529

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

530

# role in the binding.

531

#

532

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

533

# identifier) representing a Google group that has been recently

534

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

535

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

536

# recovered group retains the role in the binding.

537

#

538

#

539

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

540

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

#

"A String",

],

},

],

},

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

548

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

549

#

550

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

551

# is omitted.

552

#

553

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

554

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

},

],

}</pre>

</div>

</body></html>