Blame - docs/dyn/cloudresourcemanager_v2.folders.html - platform/external/python/google-api-python-client

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

[diff] [blame]

194

# different programming environments, including REST APIs and RPC APIs. It is

195

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

196

# three pieces of data: error code, error message, and error details.

197

#

198

# You can find out more about this error model and how to work with it in the

199

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

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

[diff] [blame]

200

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

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

[diff] [blame]

201

# message types for APIs to use.

202

{

Bu Sun Kim

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

[diff] [blame]

203

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

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

[diff] [blame]

204

},

205

],

Bu Sun Kim

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

[diff] [blame^]

206

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

207

"message": "A String", # A developer-facing error message, which should be in English. Any

208

# user-facing error message should be localized and sent in the

209

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

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

[diff] [blame]

210

},

Bu Sun Kim

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

[diff] [blame^]

211

"done": True or False, # If the value is `false`, it means the operation is still in progress.

212

# If `true`, the operation is completed, and either `error` or `response` is

213

# available.

214

"response": { # The normal response of the operation in case of success. If the original

215

# method returns no data on success, such as `Delete`, the response is

216

# `google.protobuf.Empty`. If the original method is standard

217

# `Get`/`Create`/`Update`, the response should be the resource. For other

218

# methods, the response should have the type `XxxResponse`, where `Xxx`

219

# is the original method name. For example, if the original method name

220

# is `TakeSnapshot()`, the inferred response type is

221

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

222

"a_key": "", # Properties of the object. Contains field @type with type URL.

223

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

229

<pre>Requests deletion of a Folder. The Folder is moved into the

230

DELETE_REQUESTED state

231

immediately, and is deleted approximately 30 days later. This method may

232

only be called on an empty Folder in the

233

ACTIVE state, where a Folder is empty if

Bu Sun Kim

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

[diff] [blame]

234

it doesn't contain any Folders or Projects in the

Bu Sun Kim

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

[diff] [blame]

235

ACTIVE state.

236

The caller must have `resourcemanager.folders.delete` permission on the

237

identified folder.

238

239

Args:

Dan O'Meara

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

[diff] [blame]

240

Bu Sun Kim

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

[diff] [blame]

241

Must be of the form `folders/{folder_id}`. (required)

242

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

249

Bu Sun Kim

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

[diff] [blame]

250

{ # A Folder in an Organization's resource hierarchy, used to

251

# organize that Organization's resources.

Bu Sun Kim

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

[diff] [blame]

252

"name": "A String", # Output only. The resource name of the Folder.

253

# Its format is `folders/{folder_id}`, for example: "folders/1234".

254

"displayName": "A String", # The folder’s display name.

Bu Sun Kim

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

[diff] [blame]

255

# A folder’s display name must be unique amongst its siblings, e.g.

256

# no two folders with the same parent can share the same display name.

257

# The display name must start and end with a letter or digit, may contain

258

# letters, digits, spaces, hyphens and underscores and can be no longer

259

# than 30 characters. This is captured by the regular expression:

260

# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Bu Sun Kim

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

[diff] [blame^]

261

"lifecycleState": "A String", # Output only. The lifecycle state of the folder.

262

# Updates to the lifecycle_state must be performed via

263

# DeleteFolder and

264

# UndeleteFolder.

265

"parent": "A String", # Required. The Folder’s parent's resource name.

266

# Updates to the folder's parent must be performed via

267

# MoveFolder.

268

"createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

274

<pre>Retrieves a Folder identified by the supplied resource name.

275

Valid Folder resource names have the format `folders/{folder_id}`

276

(for example, `folders/1234`).

277

The caller must have `resourcemanager.folders.get` permission on the

278

identified folder.

279

280

Args:

Dan O'Meara

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

[diff] [blame]

281

Bu Sun Kim

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

[diff] [blame]

282

Must be of the form `folders/{folder_id}`. (required)

283

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

290

Bu Sun Kim

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

[diff] [blame]

291

{ # A Folder in an Organization's resource hierarchy, used to

292

# organize that Organization's resources.

Bu Sun Kim

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

[diff] [blame]

293

"name": "A String", # Output only. The resource name of the Folder.

294

# Its format is `folders/{folder_id}`, for example: "folders/1234".

295

"displayName": "A String", # The folder’s display name.

Bu Sun Kim

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

[diff] [blame]

296

# A folder’s display name must be unique amongst its siblings, e.g.

297

# no two folders with the same parent can share the same display name.

298

# The display name must start and end with a letter or digit, may contain

299

# letters, digits, spaces, hyphens and underscores and can be no longer

300

# than 30 characters. This is captured by the regular expression:

301

# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Bu Sun Kim

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

[diff] [blame^]

302

"lifecycleState": "A String", # Output only. The lifecycle state of the folder.

303

# Updates to the lifecycle_state must be performed via

304

# DeleteFolder and

305

# UndeleteFolder.

306

"parent": "A String", # Required. The Folder’s parent's resource name.

307

# Updates to the folder's parent must be performed via

308

# MoveFolder.

309

"createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

315

<pre>Gets the access control policy for a Folder. The returned policy may be

316

empty if no such policy or resource exists. The `resource` field should

Bu Sun Kim

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

[diff] [blame]

317

be the Folder's resource name, e.g. "folders/1234".

Bu Sun Kim

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

[diff] [blame]

318

The caller must have `resourcemanager.folders.getIamPolicy` permission

319

on the identified folder.

320

321

Args:

322

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

323

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

324

body: object, The request body.

325

The object takes the form of:

326

327

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

328

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to

Dan O'Meara

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

[diff] [blame]

329

# `GetIamPolicy`.

Bu Sun Kim

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

[diff] [blame]

330

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.

Dan O'Meara

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

[diff] [blame]

331

#

332

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

333

# rejected.

334

#

335

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

336

# Policies without any conditional bindings may specify any valid value or

337

# leave the field unset.

Bu Sun Kim

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

[diff] [blame]

338

#

339

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

340

# [IAM

341

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

Dan O'Meara

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

[diff] [blame]

342

},

Bu Sun Kim

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

[diff] [blame]

343

}

344

345

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

352

Dan O'Meara

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

[diff] [blame]

353

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

354

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

355

#

356

#

Dan O'Meara

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

[diff] [blame]

357

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

358

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

359

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

360

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

361

# custom role.

Bu Sun Kim

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

[diff] [blame]

362

#

Bu Sun Kim

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

[diff] [blame]

363

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

364

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

365

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

366

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

367

# resources support conditions in their IAM policies, see the

368

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

Dan O'Meara

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

[diff] [blame]

369

#

370

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

371

#

372

# {

Bu Sun Kim

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

[diff] [blame]

373

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

374

# {

Bu Sun Kim

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

[diff] [blame]

375

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

376

# "members": [

377

# "user:mike@example.com",

378

# "group:admins@example.com",

379

# "domain:google.com",

380

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

Bu Sun Kim

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

[diff] [blame]

381

# ]

382

# },

383

# {

Bu Sun Kim

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

[diff] [blame]

384

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

385

# "members": [

386

# "user:eve@example.com"

387

# ],

388

# "condition": {

389

# "title": "expirable access",

390

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

391

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

Dan O'Meara

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

[diff] [blame]

392

# }

Bu Sun Kim

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

[diff] [blame]

393

# }

Dan O'Meara

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

[diff] [blame]

394

# ],

Bu Sun Kim

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

[diff] [blame]

395

# "etag": "BwWWja0YfJA=",

396

# "version": 3

Bu Sun Kim

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

[diff] [blame]

397

# }

398

#

Dan O'Meara

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

[diff] [blame]

399

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

404

# - group:admins@example.com

405

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

406

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

407

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

408

# - members:

Dan O'Meara

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

[diff] [blame]

409

# - user:eve@example.com

410

# role: roles/resourcemanager.organizationViewer

411

# condition:

412

# title: expirable access

413

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

414

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

Dan O'Meara

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

[diff] [blame]

415

# - etag: BwWWja0YfJA=

416

# - version: 3

Bu Sun Kim

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

[diff] [blame]

417

#

418

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

Dan O'Meara

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

[diff] [blame]

419

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

Bu Sun Kim

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

[diff] [blame^]

420

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

421

{ # Specifies the audit configuration for a service.

422

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

423

# identities, if any, are exempted from logging.

424

# An AuditConfig must have one or more AuditLogConfigs.

425

#

426

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

427

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

428

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

429

# AuditLogConfig are exempted.

430

#

431

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

437

# "audit_log_configs": [

438

# {

439

# "log_type": "DATA_READ",

440

# "exempted_members": [

441

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

446

# },

447

# {

448

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

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

454

# "audit_log_configs": [

455

# {

456

# "log_type": "DATA_READ"

457

# },

458

# {

459

# "log_type": "DATA_WRITE",

460

# "exempted_members": [

461

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

470

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

471

# aliya@example.com from DATA_WRITE logging.

472

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

473

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

474

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

475

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

476

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

# Example:

#

# {

# "audit_log_configs": [

481

# {

482

# "log_type": "DATA_READ",

483

# "exempted_members": [

484

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

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

494

# jose@example.com from DATA_READ logging.

495

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

496

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

497

# permission.

498

# Follows the same format of Binding.members.

"A String",

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

505

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

506

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

507

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

508

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

Bu Sun Kim

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

[diff] [blame]

509

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

510

# `members` can have the following values:

511

#

512

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

513

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

514

#

515

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

516

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

517

#

518

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

519

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

520

#

521

#

522

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

523

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

524

#

525

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

526

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

527

#

528

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

529

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

530

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

531

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

532

# retains the role in the binding.

533

#

534

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

535

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

536

# deleted. For example,

537

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

538

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

539

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

540

# role in the binding.

541

#

542

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

543

# identifier) representing a Google group that has been recently

544

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

545

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

546

# recovered group retains the role in the binding.

547

#

548

#

549

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

550

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

#

"A String",

],

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

555

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

Bu Sun Kim

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

[diff] [blame^]

556

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

557

#

558

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

559

# current request.

560

#

561

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

562

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

563

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

564

#

565

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

566

# [IAM

567

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

568

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

569

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

570

#

571

# Example (Comparison):

572

#

573

# title: "Summary size limit"

574

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

575

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

576

#

577

# Example (Equality):

578

#

579

# title: "Requestor is owner"

580

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

581

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

#

# Example (Logic):

#

# title: "Public documents"

586

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

587

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

588

#

589

# Example (Data Manipulation):

590

#

591

# title: "Notification string"

592

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

593

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

594

#

595

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

596

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

597

# documentation for additional information.

598

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

599

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

600

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

601

# syntax.

602

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

603

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

604

# expression.

605

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

606

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

607

},

Bu Sun Kim

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

[diff] [blame]

608

},

609

],

Bu Sun Kim

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

[diff] [blame]

610

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

Dan O'Meara

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

[diff] [blame]

611

#

612

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

613

# are rejected.

614

#

615

# Any operation that affects conditional role bindings must specify version

616

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

617

#

618

# * Getting a policy that includes a conditional role binding

619

# * Adding a conditional role binding to a policy

620

# * Changing a conditional role binding in a policy

621

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

622

# that includes conditions

623

#

624

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

625

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

626

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

627

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

628

#

629

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

630

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

631

#

632

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

633

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

Bu Sun Kim

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

[diff] [blame^]

634

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

635

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

636

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

637

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

638

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

639

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

640

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

641

#

642

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

643

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

644

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

645

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

650

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

Bu Sun Kim

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

[diff] [blame]

651

<pre>Lists the Folders that are direct descendants of supplied parent resource.

652

List provides a strongly consistent view of the Folders underneath

653

the specified parent resource.

654

List returns Folders sorted based upon the (ascending) lexical ordering

655

of their display_name.

656

The caller must have `resourcemanager.folders.list` permission on the

657

identified parent.

658

659

Args:

Bu Sun Kim

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

[diff] [blame^]

660

showDeleted: boolean, Optional. Controls whether Folders in the

661

DELETE_REQUESTED

662

state should be returned. Defaults to false.

Dan O'Meara

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

[diff] [blame]

663

parent: string, Required. The resource name of the Organization or Folder whose Folders are

Bu Sun Kim

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

[diff] [blame]

664

being listed.

665

Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.

666

Access to this method is controlled by checking the

667

`resourcemanager.folders.list` permission on the `parent`.

Bu Sun Kim

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

[diff] [blame^]

668

pageToken: string, Optional. A pagination token returned from a previous call to `ListFolders`

669

that indicates where this listing should continue from.

670

pageSize: integer, Optional. The maximum number of Folders to return in the response.

Bu Sun Kim

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

[diff] [blame]

671

x__xgafv: string, V1 error format.

672

Allowed values

673

1 - v1 error format

674

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

675

676

Returns:

677

An object of the form:

678

679

{ # The ListFolders response message.

Bu Sun Kim

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

[diff] [blame^]

680

"nextPageToken": "A String", # A pagination token returned from a previous call to `ListFolders`

681

# that indicates from where listing should continue.

Bu Sun Kim

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

[diff] [blame]

682

"folders": [ # A possibly paginated list of Folders that are direct descendants of

Bu Sun Kim

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

[diff] [blame]

683

# the specified parent resource.

Bu Sun Kim

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

[diff] [blame]

684

{ # A Folder in an Organization's resource hierarchy, used to

685

# organize that Organization's resources.

Bu Sun Kim

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

[diff] [blame]

686

"name": "A String", # Output only. The resource name of the Folder.

687

# Its format is `folders/{folder_id}`, for example: "folders/1234".

688

"displayName": "A String", # The folder’s display name.

Bu Sun Kim

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

[diff] [blame]

689

# A folder’s display name must be unique amongst its siblings, e.g.

690

# no two folders with the same parent can share the same display name.

691

# The display name must start and end with a letter or digit, may contain

692

# letters, digits, spaces, hyphens and underscores and can be no longer

693

# than 30 characters. This is captured by the regular expression:

694

# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Bu Sun Kim

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

[diff] [blame^]

695

"lifecycleState": "A String", # Output only. The lifecycle state of the folder.

696

# Updates to the lifecycle_state must be performed via

697

# DeleteFolder and

698

# UndeleteFolder.

699

"parent": "A String", # Required. The Folder’s parent's resource name.

700

# Updates to the folder's parent must be performed via

701

# MoveFolder.

702

"createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

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

710

<pre>Retrieves the next page of results.

711

712

Args:

713

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

714

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

715

716

Returns:

Bu Sun Kim

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

[diff] [blame]

717

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

Bu Sun Kim

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

[diff] [blame]

718

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]

723

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

Bu Sun Kim

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

[diff] [blame]

724

<pre>Moves a Folder under a new resource parent.

725

Returns an Operation which can be used to track the progress of the

726

folder move workflow.

727

Upon success the Operation.response field will be populated with the

728

moved Folder.

729

Upon failure, a FolderOperationError categorizing the failure cause will

730

be returned - if the failure occurs synchronously then the

731

FolderOperationError will be returned via the Status.details field

732

and if it occurs asynchronously then the FolderOperation will be returned

733

via the Operation.error field.

734

In addition, the Operation.metadata field will be populated with a

735

FolderOperation message as an aid to stateless clients.

736

Folder moves will be rejected if they violate either the naming, height

737

or fanout constraints described in the

738

CreateFolder documentation.

739

The caller must have `resourcemanager.folders.move` permission on the

Bu Sun Kim

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

[diff] [blame]

740

folder's current and proposed new parent.

Bu Sun Kim

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

[diff] [blame]

741

742

Args:

Dan O'Meara

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

[diff] [blame]

743

Bu Sun Kim

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

[diff] [blame]

744

Must be of the form folders/{folder_id} (required)

Dan O'Meara

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

[diff] [blame]

745

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

746

The object takes the form of:

747

748

{ # The MoveFolder request message.

Bu Sun Kim

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

[diff] [blame]

749

"destinationParent": "A String", # Required. The resource name of the Folder or Organization to reparent

Bu Sun Kim

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

[diff] [blame]

750

# the folder under.

751

# Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.

752

}

753

754

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

761

762

{ # This resource represents a long-running operation that is the result of a

763

# network API call.

Bu Sun Kim

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

[diff] [blame^]

764

"metadata": { # Service-specific metadata associated with the operation. It typically

765

# contains progress information and common metadata such as create time.

766

# Some services might not provide such metadata. Any method that returns a

767

# long-running operation should document the metadata type, if any.

Bu Sun Kim

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

[diff] [blame]

768

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

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

[diff] [blame]

769

},

Bu Sun Kim

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

[diff] [blame]

770

"name": "A String", # The server-assigned name, which is only unique within the same service that

Bu Sun Kim

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

[diff] [blame]

771

# originally returns it. If you use the default HTTP mapping, the

772

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

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

[diff] [blame]

773

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

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

[diff] [blame]

774

# different programming environments, including REST APIs and RPC APIs. It is

775

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

776

# three pieces of data: error code, error message, and error details.

777

#

778

# You can find out more about this error model and how to work with it in the

779

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

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

[diff] [blame]

780

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

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

[diff] [blame]

781

# message types for APIs to use.

782

{

Bu Sun Kim

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

[diff] [blame]

783

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

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

[diff] [blame]

784

},

785

],

Bu Sun Kim

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

[diff] [blame^]

786

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

787

"message": "A String", # A developer-facing error message, which should be in English. Any

788

# user-facing error message should be localized and sent in the

789

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

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

[diff] [blame]

790

},

Bu Sun Kim

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

[diff] [blame^]

791

"done": True or False, # If the value is `false`, it means the operation is still in progress.

792

# If `true`, the operation is completed, and either `error` or `response` is

793

# available.

794

"response": { # The normal response of the operation in case of success. If the original

795

# method returns no data on success, such as `Delete`, the response is

796

# `google.protobuf.Empty`. If the original method is standard

797

# `Get`/`Create`/`Update`, the response should be the resource. For other

798

# methods, the response should have the type `XxxResponse`, where `Xxx`

799

# is the original method name. For example, if the original method name

800

# is `TakeSnapshot()`, the inferred response type is

801

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

802

"a_key": "", # Properties of the object. Contains field @type with type URL.

803

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

808

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

809

<pre>Updates a Folder, changing its display_name.

810

Changes to the folder display_name will be rejected if they violate either

811

the display_name formatting rules or naming constraints described in

812

the CreateFolder documentation.

813

Bu Sun Kim

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

[diff] [blame]

814

The Folder's display name must start and end with a letter or digit,

Bu Sun Kim

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

[diff] [blame]

815

may contain letters, digits, spaces, hyphens and underscores and can be

816

no longer than 30 characters. This is captured by the regular expression:

817

[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

818

The caller must have `resourcemanager.folders.update` permission on the

819

identified folder.

820

821

If the update fails due to the unique name constraint then a

822

PreconditionFailure explaining this violation will be returned

823

in the Status.details field.

Args:

Bu Sun Kim

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

[diff] [blame]

827

Its format is `folders/{folder_id}`, for example: "folders/1234". (required)

Dan O'Meara

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

[diff] [blame]

828

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

829

The object takes the form of:

830

Bu Sun Kim

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

[diff] [blame]

831

{ # A Folder in an Organization's resource hierarchy, used to

832

# organize that Organization's resources.

Bu Sun Kim

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

[diff] [blame]

833

"name": "A String", # Output only. The resource name of the Folder.

834

# Its format is `folders/{folder_id}`, for example: "folders/1234".

835

"displayName": "A String", # The folder’s display name.

Bu Sun Kim

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

[diff] [blame]

836

# A folder’s display name must be unique amongst its siblings, e.g.

837

# no two folders with the same parent can share the same display name.

838

# The display name must start and end with a letter or digit, may contain

839

# letters, digits, spaces, hyphens and underscores and can be no longer

840

# than 30 characters. This is captured by the regular expression:

841

# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Bu Sun Kim

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

[diff] [blame^]

842

"lifecycleState": "A String", # Output only. The lifecycle state of the folder.

843

# Updates to the lifecycle_state must be performed via

844

# DeleteFolder and

845

# UndeleteFolder.

846

"parent": "A String", # Required. The Folder’s parent's resource name.

847

# Updates to the folder's parent must be performed via

848

# MoveFolder.

849

"createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.

Bu Sun Kim

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

[diff] [blame]

850

}

851

Dan O'Meara

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

[diff] [blame]

852

updateMask: string, Required. Fields to be updated.

Bu Sun Kim

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

[diff] [blame]

853

Only the `display_name` can be updated.

854

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

861

Bu Sun Kim

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

[diff] [blame]

862

{ # A Folder in an Organization's resource hierarchy, used to

863

# organize that Organization's resources.

Bu Sun Kim

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

[diff] [blame]

864

"name": "A String", # Output only. The resource name of the Folder.

865

# Its format is `folders/{folder_id}`, for example: "folders/1234".

866

"displayName": "A String", # The folder’s display name.

Bu Sun Kim

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

[diff] [blame]

867

# A folder’s display name must be unique amongst its siblings, e.g.

868

# no two folders with the same parent can share the same display name.

869

# The display name must start and end with a letter or digit, may contain

870

# letters, digits, spaces, hyphens and underscores and can be no longer

871

# than 30 characters. This is captured by the regular expression:

872

# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Bu Sun Kim

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

[diff] [blame^]

873

"lifecycleState": "A String", # Output only. The lifecycle state of the folder.

874

# Updates to the lifecycle_state must be performed via

875

# DeleteFolder and

876

# UndeleteFolder.

877

"parent": "A String", # Required. The Folder’s parent's resource name.

878

# Updates to the folder's parent must be performed via

879

# MoveFolder.

880

"createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

885

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

Bu Sun Kim

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

[diff] [blame]

886

<pre>Search for folders that match specific filter criteria.

887

Search provides an eventually consistent view of the folders a user has

888

access to which meet the specified filter criteria.

889

890

This will only return folders on which the caller has the

891

permission `resourcemanager.folders.get`.

892

893

Args:

Dan O'Meara

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

[diff] [blame]

894

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

895

The object takes the form of:

896

897

{ # The request message for searching folders.

Bu Sun Kim

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

[diff] [blame^]

898

"pageSize": 42, # Optional. The maximum number of folders to return in the response.

Bu Sun Kim

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

[diff] [blame]

899

"pageToken": "A String", # Optional. A pagination token returned from a previous call to `SearchFolders`

Bu Sun Kim

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

[diff] [blame]

900

# that indicates from where search should continue.

Bu Sun Kim

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

[diff] [blame]

901

"query": "A String", # Search criteria used to select the Folders to return.

Bu Sun Kim

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

[diff] [blame]

902

# If no search criteria is specified then all accessible folders will be

903

# returned.

904

#

905

# Query expressions can be used to restrict results based upon displayName,

906

# lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`

907

# can be used along with the suffix wildcard symbol `*`.

908

#

909

# The displayName field in a query expression should use escaped quotes

910

# for values that include whitespace to prevent unexpected behavior.

911

#

912

# Some example queries are:

913

#

Dan O'Meara

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

[diff] [blame]

914

# * Query `displayName=Test*` returns Folder resources whose display name

Bu Sun Kim

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

[diff] [blame]

915

# starts with "Test".

Dan O'Meara

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

[diff] [blame]

916

# * Query `lifecycleState=ACTIVE` returns Folder resources with

917

# `lifecycleState` set to `ACTIVE`.

918

# * Query `parent=folders/123` returns Folder resources that have

919

# `folders/123` as a parent resource.

920

# * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active

921

# Folder resources that have `folders/123` as a parent resource.

Bu Sun Kim

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

[diff] [blame]

922

# * Query `displayName=\\"Test String\\"` returns Folder resources with

923

# display names that include both "Test" and "String".

Bu Sun Kim

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

[diff] [blame]

924

}

925

926

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

933

934

{ # The response message for searching folders.

Bu Sun Kim

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

[diff] [blame]

935

"folders": [ # A possibly paginated folder search results.

Bu Sun Kim

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

[diff] [blame]

936

# the specified parent resource.

Bu Sun Kim

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

[diff] [blame]

937

{ # A Folder in an Organization's resource hierarchy, used to

938

# organize that Organization's resources.

Bu Sun Kim

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

[diff] [blame]

939

"name": "A String", # Output only. The resource name of the Folder.

940

# Its format is `folders/{folder_id}`, for example: "folders/1234".

941

"displayName": "A String", # The folder’s display name.

Bu Sun Kim

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

[diff] [blame]

942

# A folder’s display name must be unique amongst its siblings, e.g.

943

# no two folders with the same parent can share the same display name.

944

# The display name must start and end with a letter or digit, may contain

945

# letters, digits, spaces, hyphens and underscores and can be no longer

946

# than 30 characters. This is captured by the regular expression:

947

# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Bu Sun Kim

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

[diff] [blame^]

948

"lifecycleState": "A String", # Output only. The lifecycle state of the folder.

949

# Updates to the lifecycle_state must be performed via

950

# DeleteFolder and

951

# UndeleteFolder.

952

"parent": "A String", # Required. The Folder’s parent's resource name.

953

# Updates to the folder's parent must be performed via

954

# MoveFolder.

955

"createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.

Bu Sun Kim

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

[diff] [blame]

956

},

957

],

Bu Sun Kim

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

[diff] [blame]

958

"nextPageToken": "A String", # A pagination token returned from a previous call to `SearchFolders`

959

# that indicates from where searching should continue.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

965

<pre>Retrieves the next page of results.

966

967

Args:

968

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

969

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

970

971

Returns:

Bu Sun Kim

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

[diff] [blame]

972

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

Bu Sun Kim

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

[diff] [blame]

973

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]

978

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

Bu Sun Kim

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

[diff] [blame]

979

<pre>Sets the access control policy on a Folder, replacing any existing policy.

Bu Sun Kim

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

[diff] [blame]

980

The `resource` field should be the Folder's resource name, e.g.

981

"folders/1234".

Bu Sun Kim

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

[diff] [blame]

982

The caller must have `resourcemanager.folders.setIamPolicy` permission

983

on the identified folder.

984

985

Args:

986

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

987

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

Dan O'Meara

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

[diff] [blame]

988

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

989

The object takes the form of:

990

991

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

992

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

Bu Sun Kim

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

[diff] [blame]

993

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

994

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

995

# might reject them.

Dan O'Meara

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

[diff] [blame]

996

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

997

#

998

#

Dan O'Meara

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

[diff] [blame]

999

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

1000

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

1001

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

1002

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

1003

# custom role.

Bu Sun Kim

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

[diff] [blame]

1004

#

Bu Sun Kim

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

[diff] [blame]

1005

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

1006

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

1007

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

1008

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

1009

# resources support conditions in their IAM policies, see the

1010

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

Dan O'Meara

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

[diff] [blame]

1011

#

1012

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1013

#

1014

# {

Bu Sun Kim

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

[diff] [blame]

1015

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

1016

# {

Bu Sun Kim

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

[diff] [blame]

1017

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

1018

# "members": [

1019

# "user:mike@example.com",

1020

# "group:admins@example.com",

1021

# "domain:google.com",

1022

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

Bu Sun Kim

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

[diff] [blame]

1023

# ]

1024

# },

1025

# {

Bu Sun Kim

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

[diff] [blame]

1026

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

1027

# "members": [

1028

# "user:eve@example.com"

1029

# ],

1030

# "condition": {

1031

# "title": "expirable access",

1032

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

1033

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

Dan O'Meara

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

[diff] [blame]

1034

# }

Bu Sun Kim

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

[diff] [blame]

1035

# }

Dan O'Meara

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

[diff] [blame]

1036

# ],

Bu Sun Kim

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

[diff] [blame]

1037

# "etag": "BwWWja0YfJA=",

1038

# "version": 3

Bu Sun Kim

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

[diff] [blame]

1039

# }

1040

#

Dan O'Meara

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

[diff] [blame]

1041

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1046

# - group:admins@example.com

1047

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1048

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

1049

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1050

# - members:

Dan O'Meara

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

[diff] [blame]

1051

# - user:eve@example.com

1052

# role: roles/resourcemanager.organizationViewer

1053

# condition:

1054

# title: expirable access

1055

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1056

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

Dan O'Meara

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

[diff] [blame]

1057

# - etag: BwWWja0YfJA=

1058

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1059

#

1060

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

Dan O'Meara

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

[diff] [blame]

1061

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

Bu Sun Kim

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

[diff] [blame^]

1062

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

1063

{ # Specifies the audit configuration for a service.

1064

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

1065

# identities, if any, are exempted from logging.

1066

# An AuditConfig must have one or more AuditLogConfigs.

1067

#

1068

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

1069

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

1070

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

1071

# AuditLogConfig are exempted.

1072

#

1073

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

1079

# "audit_log_configs": [

1080

# {

1081

# "log_type": "DATA_READ",

1082

# "exempted_members": [

1083

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

1088

# },

1089

# {

1090

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

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

1096

# "audit_log_configs": [

1097

# {

1098

# "log_type": "DATA_READ"

1099

# },

1100

# {

1101

# "log_type": "DATA_WRITE",

1102

# "exempted_members": [

1103

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1112

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

1113

# aliya@example.com from DATA_WRITE logging.

1114

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

1115

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

1116

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

1117

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

1118

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

# Example:

#

# {

# "audit_log_configs": [

1123

# {

1124

# "log_type": "DATA_READ",

1125

# "exempted_members": [

1126

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

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

1136

# jose@example.com from DATA_READ logging.

1137

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

1138

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

1139

# permission.

1140

# Follows the same format of Binding.members.

"A String",

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1147

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

1148

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

1149

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

1150

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

Bu Sun Kim

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

[diff] [blame]

1151

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

1152

# `members` can have the following values:

1153

#

1154

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

1155

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

1156

#

1157

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

1158

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

1159

#

1160

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

1161

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

1162

#

1163

#

1164

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

1165

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

1166

#

1167

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

1168

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

1169

#

1170

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

1171

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

1172

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

1173

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

1174

# retains the role in the binding.

1175

#

1176

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

1177

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

1178

# deleted. For example,

1179

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

1180

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

1181

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

1182

# role in the binding.

1183

#

1184

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

1185

# identifier) representing a Google group that has been recently

1186

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

1187

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

1188

# recovered group retains the role in the binding.

1189

#

1190

#

1191

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

1192

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

#

"A String",

],

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

1197

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

Bu Sun Kim

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

[diff] [blame^]

1198

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

1199

#

1200

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

1201

# current request.

1202

#

1203

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

1204

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

1205

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

1206

#

1207

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

1208

# [IAM

1209

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

1210

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

1211

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

1212

#

1213

# Example (Comparison):

1214

#

1215

# title: "Summary size limit"

1216

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

1217

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

1218

#

1219

# Example (Equality):

1220

#

1221

# title: "Requestor is owner"

1222

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

1223

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

#

# Example (Logic):

#

# title: "Public documents"

1228

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

1229

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

1230

#

1231

# Example (Data Manipulation):

1232

#

1233

# title: "Notification string"

1234

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

1235

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

1236

#

1237

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

1238

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

1239

# documentation for additional information.

1240

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

1241

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

1242

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

1243

# syntax.

1244

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

1245

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

1246

# expression.

1247

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

1248

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

1249

},

Bu Sun Kim

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

[diff] [blame]

1250

},

1251

],

Bu Sun Kim

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

[diff] [blame]

1252

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

Dan O'Meara

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

[diff] [blame]

1253

#

1254

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

1255

# are rejected.

1256

#

1257

# Any operation that affects conditional role bindings must specify version

1258

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

1259

#

1260

# * Getting a policy that includes a conditional role binding

1261

# * Adding a conditional role binding to a policy

1262

# * Changing a conditional role binding in a policy

1263

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

1264

# that includes conditions

1265

#

1266

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

1267

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

1268

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

1269

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

1270

#

1271

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

1272

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

1273

#

1274

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

1275

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

Bu Sun Kim

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

[diff] [blame^]

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

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

1283

#

1284

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

1285

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

1286

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

1287

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

Bu Sun Kim

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

[diff] [blame]

1288

},

Bu Sun Kim

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

[diff] [blame]

1289

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

Bu Sun Kim

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

[diff] [blame]

1290

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

1291

# following default mask is used:

Dan O'Meara

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

[diff] [blame]

1292

#

Bu Sun Kim

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

[diff] [blame]

1293

# `paths: "bindings, etag"`

Bu Sun Kim

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

[diff] [blame]

1294

}

1295

1296

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1303

Dan O'Meara

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

[diff] [blame]

1304

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

1305

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

1306

#

1307

#

Dan O'Meara

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

[diff] [blame]

1308

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

1309

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

1310

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

1311

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

1312

# custom role.

Bu Sun Kim

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

[diff] [blame]

1313

#

Bu Sun Kim

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

[diff] [blame]

1314

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

1315

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

1316

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

1317

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

1318

# resources support conditions in their IAM policies, see the

1319

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

Dan O'Meara

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

[diff] [blame]

1320

#

1321

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1322

#

1323

# {

Bu Sun Kim

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

[diff] [blame]

1324

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

1325

# {

Bu Sun Kim

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

[diff] [blame]

1326

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

1327

# "members": [

1328

# "user:mike@example.com",

1329

# "group:admins@example.com",

1330

# "domain:google.com",

1331

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

Bu Sun Kim

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

[diff] [blame]

1332

# ]

1333

# },

1334

# {

Bu Sun Kim

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

[diff] [blame]

1335

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

1336

# "members": [

1337

# "user:eve@example.com"

1338

# ],

1339

# "condition": {

1340

# "title": "expirable access",

1341

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

1342

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

Dan O'Meara

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

[diff] [blame]

1343

# }

Bu Sun Kim

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

[diff] [blame]

1344

# }

Dan O'Meara

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

[diff] [blame]

1345

# ],

Bu Sun Kim

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

[diff] [blame]

1346

# "etag": "BwWWja0YfJA=",

1347

# "version": 3

Bu Sun Kim

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

[diff] [blame]

1348

# }

1349

#

Dan O'Meara

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

[diff] [blame]

1350

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1355

# - group:admins@example.com

1356

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1357

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

1358

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1359

# - members:

Dan O'Meara

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

[diff] [blame]

1360

# - user:eve@example.com

1361

# role: roles/resourcemanager.organizationViewer

1362

# condition:

1363

# title: expirable access

1364

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1365

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

Dan O'Meara

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

[diff] [blame]

1366

# - etag: BwWWja0YfJA=

1367

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1368

#

1369

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

Dan O'Meara

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

[diff] [blame]

1370

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

Bu Sun Kim

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

[diff] [blame^]

1371

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

1372

{ # Specifies the audit configuration for a service.

1373

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

1374

# identities, if any, are exempted from logging.

1375

# An AuditConfig must have one or more AuditLogConfigs.

1376

#

1377

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

1378

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

1379

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

1380

# AuditLogConfig are exempted.

1381

#

1382

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

1388

# "audit_log_configs": [

1389

# {

1390

# "log_type": "DATA_READ",

1391

# "exempted_members": [

1392

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

1397

# },

1398

# {

1399

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

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

1405

# "audit_log_configs": [

1406

# {

1407

# "log_type": "DATA_READ"

1408

# },

1409

# {

1410

# "log_type": "DATA_WRITE",

1411

# "exempted_members": [

1412

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1421

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

1422

# aliya@example.com from DATA_WRITE logging.

1423

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

1424

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

1425

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

1426

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

1427

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

# Example:

#

# {

# "audit_log_configs": [

1432

# {

1433

# "log_type": "DATA_READ",

1434

# "exempted_members": [

1435

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

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

1445

# jose@example.com from DATA_READ logging.

1446

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

1447

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

1448

# permission.

1449

# Follows the same format of Binding.members.

"A String",

],

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

1456

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

1457

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

1458

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

1459

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

Bu Sun Kim

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

[diff] [blame]

1460

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

1461

# `members` can have the following values:

1462

#

1463

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

1464

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

1465

#

1466

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

1467

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

1468

#

1469

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

1470

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

1471

#

1472

#

1473

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

1474

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

1475

#

1476

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

1477

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

1478

#

1479

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

1480

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

1481

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

1482

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

1483

# retains the role in the binding.

1484

#

1485

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

1486

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

1487

# deleted. For example,

1488

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

1489

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

1490

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

1491

# role in the binding.

1492

#

1493

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

1494

# identifier) representing a Google group that has been recently

1495

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

1496

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

1497

# recovered group retains the role in the binding.

1498

#

1499

#

1500

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

1501

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

#

"A String",

],

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

1506

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

Bu Sun Kim

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

[diff] [blame^]

1507

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

1508

#

1509

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

1510

# current request.

1511

#

1512

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

1513

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

1514

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

1515

#

1516

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

1517

# [IAM

1518

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

1519

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

1520

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

1521

#

1522

# Example (Comparison):

1523

#

1524

# title: "Summary size limit"

1525

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

1526

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

1527

#

1528

# Example (Equality):

1529

#

1530

# title: "Requestor is owner"

1531

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

1532

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

#

# Example (Logic):

#

# title: "Public documents"

1537

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

1538

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

1539

#

1540

# Example (Data Manipulation):

1541

#

1542

# title: "Notification string"

1543

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

1544

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

1545

#

1546

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

1547

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

1548

# documentation for additional information.

1549

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

1550

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

1551

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

1552

# syntax.

1553

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

1554

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

1555

# expression.

1556

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

1557

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

1558

},

Bu Sun Kim

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

[diff] [blame]

1559

},

1560

],

Bu Sun Kim

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

[diff] [blame]

1561

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

Dan O'Meara

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

[diff] [blame]

1562

#

1563

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

1564

# are rejected.

1565

#

1566

# Any operation that affects conditional role bindings must specify version

1567

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

1568

#

1569

# * Getting a policy that includes a conditional role binding

1570

# * Adding a conditional role binding to a policy

1571

# * Changing a conditional role binding in a policy

1572

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

1573

# that includes conditions

1574

#

1575

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

1576

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

1577

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

1578

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

1579

#

1580

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

1581

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

1582

#

1583

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

1584

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

Bu Sun Kim

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

[diff] [blame^]

1585

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

1586

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

1587

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

1588

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

1589

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

1590

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

1591

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

1592

#

1593

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

1594

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

1595

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

1596

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1601

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

Bu Sun Kim

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

[diff] [blame]

1602

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

Bu Sun Kim

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

[diff] [blame]

1603

The `resource` field should be the Folder's resource name,

1604

e.g. "folders/1234".

Bu Sun Kim

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

[diff] [blame]

1605

1606

There are no permissions required for making this API call.

1607

1608

Args:

1609

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

1610

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

Dan O'Meara

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

[diff] [blame]

1611

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1612

The object takes the form of:

1613

1614

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1615

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

1616

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

Bu Sun Kim

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

[diff] [blame]

1617

# information see

1618

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

Bu Sun Kim

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

[diff] [blame]

1619

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -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:

1630

1631

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1632

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

Bu Sun Kim

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

[diff] [blame]

1633

# allowed.

Bu Sun Kim

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

[diff] [blame]

1634

"A String",

Bu Sun Kim

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

[diff] [blame]

],

}</pre>

</div>

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

1641

<pre>Cancels the deletion request for a Folder. This method may only be

1642

called on a Folder in the

1643

DELETE_REQUESTED state.

Bu Sun Kim

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

[diff] [blame]

1644

In order to succeed, the Folder's parent must be in the

Bu Sun Kim

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

[diff] [blame]

1645

ACTIVE state.

1646

In addition, reintroducing the folder into the tree must not violate

1647

folder naming, height and fanout constraints described in the

1648

CreateFolder documentation.

1649

The caller must have `resourcemanager.folders.undelete` permission on the

1650

identified folder.

1651

1652

Args:

Dan O'Meara

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

[diff] [blame]

1653

Bu Sun Kim

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

[diff] [blame]

1654

Must be of the form `folders/{folder_id}`. (required)

1655

body: object, The request body.

1656

The object takes the form of:

1657

1658

{ # The UndeleteFolder request message.

1659

}

1660

1661

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1668

Bu Sun Kim

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

[diff] [blame]

1669

{ # A Folder in an Organization's resource hierarchy, used to

1670

# organize that Organization's resources.

Bu Sun Kim

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

[diff] [blame]

1671

"name": "A String", # Output only. The resource name of the Folder.

1672

# Its format is `folders/{folder_id}`, for example: "folders/1234".

1673

"displayName": "A String", # The folder’s display name.

Bu Sun Kim

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

[diff] [blame]

1674

# A folder’s display name must be unique amongst its siblings, e.g.

1675

# no two folders with the same parent can share the same display name.

1676

# The display name must start and end with a letter or digit, may contain

1677

# letters, digits, spaces, hyphens and underscores and can be no longer

1678

# than 30 characters. This is captured by the regular expression:

1679

# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Bu Sun Kim

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

[diff] [blame^]

1680

"lifecycleState": "A String", # Output only. The lifecycle state of the folder.

1681

# Updates to the lifecycle_state must be performed via

1682

# DeleteFolder and

1683

# UndeleteFolder.

1684

"parent": "A String", # Required. The Folder’s parent's resource name.

1685

# Updates to the folder's parent must be performed via

1686

# MoveFolder.

1687

"createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.

Bu Sun Kim