Blame - docs/dyn/cloudkms_v1.projects.locations.keyRings.html - platform/external/python/google-api-python-client

2017-03-13 12:12:03 -0400

[diff] [blame]

76

<h2>Instance Methods</h2>

77

78

<code><a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.html">cryptoKeys()</a></code>

79

</p>

80

<p class="firstline">Returns the cryptoKeys Resource.</p>

81

82

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

83

<code><a href="cloudkms_v1.projects.locations.keyRings.importJobs.html">importJobs()</a></code>

84

</p>

85

<p class="firstline">Returns the importJobs Resource.</p>

86

87

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

88

<code><a href="#create">create(parent, body=None, keyRingId=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

89

<p class="firstline">Create a new KeyRing in a given Project and Location.</p>

90

91

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

92

<p class="firstline">Returns metadata for a given KeyRing.</p>

93

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

94

<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

95

<p class="firstline">Gets the access control policy for a resource.</p>

96

Bu Sun Kim

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

[diff] [blame]

97

<code><a href="#list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

98

<p class="firstline">Lists KeyRings.</p>

99

100

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

101

<p class="firstline">Retrieves the next page of results.</p>

102

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

103

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

104

<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>

105

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

106

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

107

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

108

<h3>Method Details</h3>

109

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

<code class="details" id="create">create(parent, body=None, keyRingId=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

111

<pre>Create a new KeyRing in a given Project and Location.

112

113

Args:

114

parent: string, Required. The resource name of the location associated with the

115

KeyRings, in the format `projects/*/locations/*`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

116

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

117

The object takes the form of:

118

119

{ # A KeyRing is a toplevel logical grouping of CryptoKeys.

Bu Sun Kim

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

[diff] [blame]

120

"name": "A String", # Output only. The resource name for the KeyRing in the format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

121

# `projects/*/locations/*/keyRings/*`.

Bu Sun Kim

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

[diff] [blame]

122

"createTime": "A String", # Output only. The time at which this KeyRing was created.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

123

}

124

125

keyRingId: string, Required. It must be unique within a location and match the regular

126

expression `[a-zA-Z0-9_-]{1,63}`

127

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

134

135

{ # A KeyRing is a toplevel logical grouping of CryptoKeys.

Bu Sun Kim

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

[diff] [blame]

136

"name": "A String", # Output only. The resource name for the KeyRing in the format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

137

# `projects/*/locations/*/keyRings/*`.

Bu Sun Kim

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

[diff] [blame]

138

"createTime": "A String", # Output only. The time at which this KeyRing was created.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

144

<pre>Returns metadata for a given KeyRing.

145

146

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

147

name: string, Required. The name of the KeyRing to get. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

148

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

155

156

{ # A KeyRing is a toplevel logical grouping of CryptoKeys.

Bu Sun Kim

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

[diff] [blame]

157

"name": "A String", # Output only. The resource name for the KeyRing in the format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

158

# `projects/*/locations/*/keyRings/*`.

Bu Sun Kim

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

[diff] [blame]

159

"createTime": "A String", # Output only. The time at which this KeyRing was created.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

164

<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

165

<pre>Gets the access control policy for a resource.

166

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

171

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

172

options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.

173

174

Valid values are 0, 1, and 3. Requests specifying an invalid value will be

175

rejected.

176

177

Requests for policies with any conditional bindings must specify version 3.

178

Policies without any conditional bindings may specify any valid value or

179

leave the field unset.

Bu Sun Kim

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

[diff] [blame]

180

181

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

182

[IAM

183

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

184

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

191

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

192

{ # An Identity and Access Management (IAM) policy, which specifies access

193

# controls for Google Cloud resources.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

194

#

195

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

196

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

197

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

198

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

199

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

200

# custom role.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

201

#

Bu Sun Kim

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

[diff] [blame]

202

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

203

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

204

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

205

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

206

# resources support conditions in their IAM policies, see the

207

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

208

#

209

# **JSON example:**

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

210

#

211

# {

Bu Sun Kim

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

[diff] [blame]

212

# "bindings": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

213

# {

Bu Sun Kim

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

[diff] [blame]

214

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

215

# "members": [

216

# "user:mike@example.com",

217

# "group:admins@example.com",

218

# "domain:google.com",

219

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

220

# ]

221

# },

222

# {

Bu Sun Kim

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

[diff] [blame]

223

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

224

# "members": [

225

# "user:eve@example.com"

226

# ],

227

# "condition": {

228

# "title": "expirable access",

229

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

230

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

231

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

232

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

233

# ],

Bu Sun Kim

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

[diff] [blame]

234

# "etag": "BwWWja0YfJA=",

235

# "version": 3

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

236

# }

237

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

238

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

243

# - group:admins@example.com

244

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

245

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

246

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

247

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

248

# - user:eve@example.com

249

# role: roles/resourcemanager.organizationViewer

250

# condition:

251

# title: expirable access

252

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

253

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

254

# - etag: BwWWja0YfJA=

255

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

256

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

257

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

258

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

Bu Sun Kim

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

[diff] [blame]

259

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

260

#

261

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

262

# are rejected.

263

#

264

# Any operation that affects conditional role bindings must specify version

265

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

266

#

267

# * Getting a policy that includes a conditional role binding

268

# * Adding a conditional role binding to a policy

269

# * Changing a conditional role binding in a policy

270

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

271

# that includes conditions

272

#

273

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

274

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

275

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

276

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

277

#

278

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

279

# specify any valid version or leave the field unset.

280

#

281

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

282

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

283

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

284

{ # Specifies the audit configuration for a service.

285

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

286

# identities, if any, are exempted from logging.

287

# An AuditConfig must have one or more AuditLogConfigs.

288

#

289

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

290

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

291

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

292

# AuditLogConfig are exempted.

293

#

294

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

300

# "audit_log_configs": [

301

# {

302

# "log_type": "DATA_READ",

303

# "exempted_members": [

304

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

309

# },

310

# {

311

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

317

# "audit_log_configs": [

318

# {

319

# "log_type": "DATA_READ",

320

# },

321

# {

322

# "log_type": "DATA_WRITE",

323

# "exempted_members": [

324

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

333

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

334

# aliya@example.com from DATA_WRITE logging.

335

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

336

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

# Example:

#

# {

# "audit_log_configs": [

341

# {

342

# "log_type": "DATA_READ",

343

# "exempted_members": [

344

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

354

# jose@example.com from DATA_READ logging.

355

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

356

# permission.

357

# Follows the same format of Binding.members.

358

"A String",

359

],

360

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

361

},

362

],

363

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

364

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

365

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

366

},

367

],

368

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

369

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

370

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

371

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

Bu Sun Kim

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

[diff] [blame]

372

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

373

# `members` can have the following values:

374

#

375

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

376

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

377

#

378

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

379

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

380

#

381

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

382

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

383

#

384

#

385

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

386

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

387

#

388

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

389

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

390

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

391

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

392

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

393

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

394

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

395

# retains the role in the binding.

396

#

397

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

398

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

399

# deleted. For example,

400

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

401

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

402

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

403

# role in the binding.

404

#

405

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

406

# identifier) representing a Google group that has been recently

407

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

408

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

409

# recovered group retains the role in the binding.

410

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

411

#

412

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

413

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

414

#

Bu Sun Kim

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

[diff] [blame]

415

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

416

],

Bu Sun Kim

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

[diff] [blame]

417

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

418

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

419

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

420

#

421

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

422

# current request.

423

#

424

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

425

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

426

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

427

#

428

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

429

# [IAM

430

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

431

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

432

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

433

#

434

# Example (Comparison):

435

#

436

# title: "Summary size limit"

437

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

438

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

439

#

440

# Example (Equality):

441

#

442

# title: "Requestor is owner"

443

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

444

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

#

# Example (Logic):

#

# title: "Public documents"

449

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

450

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

451

#

452

# Example (Data Manipulation):

453

#

454

# title: "Notification string"

455

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

456

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

457

#

458

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

459

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

460

# documentation for additional information.

461

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

462

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

463

# expression.

464

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

465

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

466

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

467

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

468

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

469

# syntax.

470

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

471

},

472

],

Bu Sun Kim

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

[diff] [blame]

473

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

474

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

475

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

476

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

477

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

478

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

479

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

480

#

481

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

482

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

483

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

484

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

489

<code class="details" id="list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

<pre>Lists KeyRings.

Args:

parent: string, Required. The resource name of the location associated with the

494

KeyRings, in the format `projects/*/locations/*`. (required)

Bu Sun Kim

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

[diff] [blame]

495

pageToken: string, Optional. Optional pagination token, returned earlier via

496

ListKeyRingsResponse.next_page_token.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

497

orderBy: string, Optional. Specify how the results should be sorted. If not specified, the

498

results will be sorted in the default order. For more information, see

499

[Sorting and filtering list

500

results](https://cloud.google.com/kms/docs/sorting-and-filtering).

501

pageSize: integer, Optional. Optional limit on the number of KeyRings to include in the

502

response. Further KeyRings can subsequently be obtained by

503

including the ListKeyRingsResponse.next_page_token in a subsequent

504

request. If unspecified, the server will pick an appropriate default.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

505

filter: string, Optional. Only include resources that match the filter in the response. For

506

more information, see

507

[Sorting and filtering list

508

results](https://cloud.google.com/kms/docs/sorting-and-filtering).

Bu Sun Kim

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

[diff] [blame]

509

x__xgafv: string, V1 error format.

510

Allowed values

511

1 - v1 error format

512

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

513

514

Returns:

515

An object of the form:

516

517

{ # Response message for KeyManagementService.ListKeyRings.

Bu Sun Kim

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

[diff] [blame]

518

"keyRings": [ # The list of KeyRings.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

519

{ # A KeyRing is a toplevel logical grouping of CryptoKeys.

Bu Sun Kim

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

[diff] [blame]

520

"name": "A String", # Output only. The resource name for the KeyRing in the format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

521

# `projects/*/locations/*/keyRings/*`.

Bu Sun Kim

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

[diff] [blame]

522

"createTime": "A String", # Output only. The time at which this KeyRing was created.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

523

},

524

],

Bu Sun Kim

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

[diff] [blame]

525

"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in

526

# ListKeyRingsRequest.page_token to retrieve the next page of results.

527

"totalSize": 42, # The total number of KeyRings that matched the query.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

533

<pre>Retrieves the next page of results.

534

535

Args:

536

previous_request: The request for the previous page. (required)

537

previous_response: The response from the request for the previous page. (required)

538

539

Returns:

Bu Sun Kim

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

[diff] [blame]

540

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

541

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

546

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

547

<pre>Sets the access control policy on the specified resource. Replaces any

548

existing policy.

549

Bu Sun Kim

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

[diff] [blame]

550

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

551

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

552

Args:

553

resource: string, REQUIRED: The resource for which the policy is being specified.

554

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

555

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

556

The object takes the form of:

557

558

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

559

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

560

# the policy is limited to a few 10s of KB. An empty policy is a

561

# valid policy but certain Cloud Platform services (such as Projects)

562

# might reject them.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

563

# controls for Google Cloud resources.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

564

#

565

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

566

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

567

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

568

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

569

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

570

# custom role.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

571

#

Bu Sun Kim

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

[diff] [blame]

572

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

573

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

574

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

575

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

576

# resources support conditions in their IAM policies, see the

577

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

578

#

579

# **JSON example:**

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

580

#

581

# {

Bu Sun Kim

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

[diff] [blame]

582

# "bindings": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

583

# {

Bu Sun Kim

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

[diff] [blame]

584

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

585

# "members": [

586

# "user:mike@example.com",

587

# "group:admins@example.com",

588

# "domain:google.com",

589

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

590

# ]

591

# },

592

# {

Bu Sun Kim

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

[diff] [blame]

593

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

594

# "members": [

595

# "user:eve@example.com"

596

# ],

597

# "condition": {

598

# "title": "expirable access",

599

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

600

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

601

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

602

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

603

# ],

Bu Sun Kim

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

[diff] [blame]

604

# "etag": "BwWWja0YfJA=",

605

# "version": 3

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

606

# }

607

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

608

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

613

# - group:admins@example.com

614

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

615

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

616

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

617

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

618

# - user:eve@example.com

619

# role: roles/resourcemanager.organizationViewer

620

# condition:

621

# title: expirable access

622

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

623

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

624

# - etag: BwWWja0YfJA=

625

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

626

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

627

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

628

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

Bu Sun Kim

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

[diff] [blame]

629

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

630

#

631

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

632

# are rejected.

633

#

634

# Any operation that affects conditional role bindings must specify version

635

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

636

#

637

# * Getting a policy that includes a conditional role binding

638

# * Adding a conditional role binding to a policy

639

# * Changing a conditional role binding in a policy

640

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

641

# that includes conditions

642

#

643

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

644

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

645

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

646

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

647

#

648

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

649

# specify any valid version or leave the field unset.

650

#

651

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

652

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

653

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

654

{ # Specifies the audit configuration for a service.

655

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

656

# identities, if any, are exempted from logging.

657

# An AuditConfig must have one or more AuditLogConfigs.

658

#

659

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

660

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

661

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

662

# AuditLogConfig are exempted.

663

#

664

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

670

# "audit_log_configs": [

671

# {

672

# "log_type": "DATA_READ",

673

# "exempted_members": [

674

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

679

# },

680

# {

681

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

687

# "audit_log_configs": [

688

# {

689

# "log_type": "DATA_READ",

690

# },

691

# {

692

# "log_type": "DATA_WRITE",

693

# "exempted_members": [

694

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

703

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

704

# aliya@example.com from DATA_WRITE logging.

705

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

706

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

# Example:

#

# {

# "audit_log_configs": [

711

# {

712

# "log_type": "DATA_READ",

713

# "exempted_members": [

714

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

724

# jose@example.com from DATA_READ logging.

725

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

726

# permission.

727

# Follows the same format of Binding.members.

728

"A String",

729

],

730

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

731

},

732

],

733

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

734

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

735

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

736

},

737

],

738

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

739

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

740

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

741

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

Bu Sun Kim

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

[diff] [blame]

742

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

743

# `members` can have the following values:

744

#

745

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

746

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

747

#

748

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

749

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

750

#

751

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

752

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

753

#

754

#

755

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

756

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

757

#

758

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

759

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

760

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

761

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

762

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

763

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

764

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

765

# retains the role in the binding.

766

#

767

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

768

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

769

# deleted. For example,

770

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

771

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

772

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

773

# role in the binding.

774

#

775

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

776

# identifier) representing a Google group that has been recently

777

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

778

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

779

# recovered group retains the role in the binding.

780

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

781

#

782

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

783

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

784

#

Bu Sun Kim

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

[diff] [blame]

785

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

786

],

Bu Sun Kim

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

[diff] [blame]

787

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

788

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

789

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

790

#

791

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

792

# current request.

793

#

794

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

795

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

796

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

797

#

798

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

799

# [IAM

800

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

801

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

802

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

803

#

804

# Example (Comparison):

805

#

806

# title: "Summary size limit"

807

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

808

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

809

#

810

# Example (Equality):

811

#

812

# title: "Requestor is owner"

813

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

814

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

#

# Example (Logic):

#

# title: "Public documents"

819

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

820

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

821

#

822

# Example (Data Manipulation):

823

#

824

# title: "Notification string"

825

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

826

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

827

#

828

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

829

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

830

# documentation for additional information.

831

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

832

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

833

# expression.

834

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

835

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

836

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

837

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

838

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

839

# syntax.

840

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

841

},

842

],

Bu Sun Kim

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

[diff] [blame]

843

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

844

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

845

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

846

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

847

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

848

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

849

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

850

#

851

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

852

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

853

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

854

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

855

},

Bu Sun Kim

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

[diff] [blame]

856

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

857

# the fields in the mask will be modified. If no mask is provided, the

858

# following default mask is used:

Bu Sun Kim

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

[diff] [blame]

859

#

860

# `paths: "bindings, etag"`

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

861

}

862

863

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

870

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

871

{ # An Identity and Access Management (IAM) policy, which specifies access

872

# controls for Google Cloud resources.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

873

#

874

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

875

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

876

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

877

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

878

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

879

# custom role.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

880

#

Bu Sun Kim

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

[diff] [blame]

881

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

882

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

883

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

884

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

885

# resources support conditions in their IAM policies, see the

886

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

887

#

888

# **JSON example:**

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

889

#

890

# {

Bu Sun Kim

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

[diff] [blame]

891

# "bindings": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

892

# {

Bu Sun Kim

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

[diff] [blame]

893

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

894

# "members": [

895

# "user:mike@example.com",

896

# "group:admins@example.com",

897

# "domain:google.com",

898

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

899

# ]

900

# },

901

# {

Bu Sun Kim

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

[diff] [blame]

902

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

903

# "members": [

904

# "user:eve@example.com"

905

# ],

906

# "condition": {

907

# "title": "expirable access",

908

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

909

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

910

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

911

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

912

# ],

Bu Sun Kim

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

[diff] [blame]

913

# "etag": "BwWWja0YfJA=",

914

# "version": 3

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

915

# }

916

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

917

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

922

# - group:admins@example.com

923

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

924

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

925

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

926

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

927

# - user:eve@example.com

928

# role: roles/resourcemanager.organizationViewer

929

# condition:

930

# title: expirable access

931

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

932

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

933

# - etag: BwWWja0YfJA=

934

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

935

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

936

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

937

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

Bu Sun Kim

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

[diff] [blame]

938

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

939

#

940

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

941

# are rejected.

942

#

943

# Any operation that affects conditional role bindings must specify version

944

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

945

#

946

# * Getting a policy that includes a conditional role binding

947

# * Adding a conditional role binding to a policy

948

# * Changing a conditional role binding in a policy

949

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

950

# that includes conditions

951

#

952

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

953

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

954

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

955

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

956

#

957

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

958

# specify any valid version or leave the field unset.

959

#

960

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

961

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

962

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

963

{ # Specifies the audit configuration for a service.

964

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

965

# identities, if any, are exempted from logging.

966

# An AuditConfig must have one or more AuditLogConfigs.

967

#

968

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

969

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

970

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

971

# AuditLogConfig are exempted.

972

#

973

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

979

# "audit_log_configs": [

980

# {

981

# "log_type": "DATA_READ",

982

# "exempted_members": [

983

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

988

# },

989

# {

990

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

996

# "audit_log_configs": [

997

# {

998

# "log_type": "DATA_READ",

999

# },

1000

# {

1001

# "log_type": "DATA_WRITE",

1002

# "exempted_members": [

1003

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1012

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

1013

# aliya@example.com from DATA_WRITE logging.

1014

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

1015

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

# Example:

#

# {

# "audit_log_configs": [

1020

# {

1021

# "log_type": "DATA_READ",

1022

# "exempted_members": [

1023

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1033

# jose@example.com from DATA_READ logging.

1034

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

1035

# permission.

1036

# Follows the same format of Binding.members.

1037

"A String",

1038

],

1039

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

1040

},

1041

],

1042

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

1043

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

1044

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

1045

},

1046

],

1047

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1048

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

1049

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1050

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

Bu Sun Kim

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

[diff] [blame]

1051

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1052

# `members` can have the following values:

1053

#

1054

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

1055

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

1056

#

1057

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

1058

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

1059

#

1060

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1061

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1062

#

1063

#

1064

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

1065

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

1066

#

1067

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

1068

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

1069

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1070

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

1071

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

1072

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

1073

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

1074

# retains the role in the binding.

1075

#

1076

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

1077

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

1078

# deleted. For example,

1079

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

1080

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

1081

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

1082

# role in the binding.

1083

#

1084

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

1085

# identifier) representing a Google group that has been recently

1086

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

1087

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

1088

# recovered group retains the role in the binding.

1089

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1090

#

1091

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

1092

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

1093

#

Bu Sun Kim

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

[diff] [blame]

1094

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1095

],

Bu Sun Kim

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

[diff] [blame]

1096

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

1097

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

1098

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

1099

#

1100

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

1101

# current request.

1102

#

1103

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

1104

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

1105

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

1106

#

1107

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

1108

# [IAM

1109

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

1110

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

1111

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

1112

#

1113

# Example (Comparison):

1114

#

1115

# title: "Summary size limit"

1116

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

1117

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

1118

#

1119

# Example (Equality):

1120

#

1121

# title: "Requestor is owner"

1122

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

1123

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

#

# Example (Logic):

#

# title: "Public documents"

1128

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

1129

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

1130

#

1131

# Example (Data Manipulation):

1132

#

1133

# title: "Notification string"

1134

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

1135

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

1136

#

1137

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

1138

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

1139

# documentation for additional information.

1140

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

1141

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

1142

# expression.

1143

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

1144

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

1145

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

1146

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

1147

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

1148

# syntax.

1149

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1150

},

1151

],

Bu Sun Kim

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

[diff] [blame]

1152

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1153

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

1154

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

1155

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

1156

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

1157

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

1158

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

1159

#

1160

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

1161

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

1162

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

1163

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1168

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1169

<pre>Returns permissions that a caller has on the specified resource.

1170

If the resource does not exist, this will return an empty set of

Bu Sun Kim

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

[diff] [blame]

1171

permissions, not a `NOT_FOUND` error.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1172

1173

Note: This operation is designed to be used for building permission-aware

1174

UIs and command-line tools, not for authorization checking. This operation

Bu Sun Kim

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

[diff] [blame]

1175

may "fail open" without warning.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1176

1177

Args:

1178

resource: string, REQUIRED: The resource for which the policy detail is being requested.

1179

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1180

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1181

The object takes the form of:

1182

1183

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1184

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

1185

# wildcards (such as '*' or 'storage.*') are not allowed. For more

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1186

# information see

1187

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

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

[diff] [blame]

1188

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1199

1200

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1201

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1202

# allowed.

Bu Sun Kim

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

[diff] [blame]

1203

"A String",

Sai Cheemalapati