Blame - docs/dyn/cloudbilling_v1.billingAccounts.html - platform/external/python/google-api-python-client

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

[diff] [blame]

674

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

675

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

676

# might reject them.

Dan O'Meara

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

[diff] [blame]

677

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

678

#

679

#

Dan O'Meara

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

[diff] [blame]

680

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

681

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

682

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

683

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

684

# custom role.

Bu Sun Kim

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

[diff] [blame]

685

#

Bu Sun Kim

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

[diff] [blame]

686

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

687

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

688

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

689

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

690

# resources support conditions in their IAM policies, see the

691

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

Dan O'Meara

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

[diff] [blame]

692

#

693

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

694

#

695

# {

Bu Sun Kim

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

[diff] [blame]

696

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

697

# {

Bu Sun Kim

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

[diff] [blame]

698

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

699

# "members": [

700

# "user:mike@example.com",

701

# "group:admins@example.com",

702

# "domain:google.com",

703

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

Bu Sun Kim

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

[diff] [blame]

704

# ]

705

# },

706

# {

Bu Sun Kim

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

[diff] [blame]

707

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

708

# "members": [

709

# "user:eve@example.com"

710

# ],

711

# "condition": {

712

# "title": "expirable access",

713

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

714

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

Dan O'Meara

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

[diff] [blame]

715

# }

Bu Sun Kim

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

[diff] [blame]

716

# }

Dan O'Meara

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

[diff] [blame]

717

# ],

Bu Sun Kim

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

[diff] [blame]

718

# "etag": "BwWWja0YfJA=",

719

# "version": 3

Bu Sun Kim

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

[diff] [blame]

720

# }

721

#

Dan O'Meara

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

[diff] [blame]

722

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

727

# - group:admins@example.com

728

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

729

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

730

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

731

# - members:

Dan O'Meara

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

[diff] [blame]

732

# - user:eve@example.com

733

# role: roles/resourcemanager.organizationViewer

734

# condition:

735

# title: expirable access

736

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

737

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

Dan O'Meara

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

[diff] [blame]

738

# - etag: BwWWja0YfJA=

739

# - version: 3

Bu Sun Kim

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

[diff] [blame]

740

#

741

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

Dan O'Meara

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

[diff] [blame]

742

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

Bu Sun Kim

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

[diff] [blame]

743

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

744

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

745

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

746

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

Bu Sun Kim

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

[diff] [blame]

747

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

748

#

749

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

750

# current request.

751

#

752

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

753

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

754

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

755

#

756

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

757

# [IAM

758

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

Dan O'Meara

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

[diff] [blame]

759

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

760

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

761

#

762

# Example (Comparison):

763

#

Bu Sun Kim

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

[diff] [blame]

764

# title: "Summary size limit"

765

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

766

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

Dan O'Meara

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

[diff] [blame]

767

#

768

# Example (Equality):

769

#

Bu Sun Kim

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

[diff] [blame]

770

# title: "Requestor is owner"

771

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

772

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

Dan O'Meara

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

[diff] [blame]

773

#

774

# Example (Logic):

775

#

Bu Sun Kim

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

[diff] [blame]

776

# title: "Public documents"

777

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

778

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

Dan O'Meara

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

[diff] [blame]

779

#

780

# Example (Data Manipulation):

781

#

Bu Sun Kim

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

[diff] [blame]

782

# title: "Notification string"

783

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

784

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

Dan O'Meara

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

[diff] [blame]

785

#

786

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

787

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

788

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

789

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

Dan O'Meara

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

[diff] [blame]

790

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

Bu Sun Kim

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

[diff] [blame]

791

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

Dan O'Meara

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

[diff] [blame]

792

# syntax.

Bu Sun Kim

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

[diff] [blame]

793

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

Dan O'Meara

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

[diff] [blame]

794

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

795

# expression.

Bu Sun Kim

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

[diff] [blame]

796

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

797

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

Dan O'Meara

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

[diff] [blame]

798

},

Bu Sun Kim

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

[diff] [blame]

799

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

Dan O'Meara

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

[diff] [blame]

800

# `members` can have the following values:

801

#

802

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

803

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

804

#

805

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

806

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

807

#

808

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

809

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

810

#

811

#

812

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

813

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

814

#

815

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

816

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

817

#

818

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

819

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

820

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

821

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

822

# retains the role in the binding.

823

#

824

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

825

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

826

# deleted. For example,

827

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

828

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

829

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

830

# role in the binding.

831

#

832

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

833

# identifier) representing a Google group that has been recently

834

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

835

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

836

# recovered group retains the role in the binding.

837

#

838

#

839

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

840

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

841

#

Bu Sun Kim

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

[diff] [blame]

842

"A String",

Dan O'Meara

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

[diff] [blame]

843

],

Bu Sun Kim

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

[diff] [blame]

844

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

845

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

Dan O'Meara

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

[diff] [blame]

846

},

847

],

Bu Sun Kim

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

[diff] [blame]

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

#

856

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

857

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

858

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

859

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

Bu Sun Kim

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

[diff] [blame]

860

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

861

#

862

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

863

# are rejected.

864

#

865

# Any operation that affects conditional role bindings must specify version

866

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

867

#

868

# * Getting a policy that includes a conditional role binding

869

# * Adding a conditional role binding to a policy

870

# * Changing a conditional role binding in a policy

871

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

872

# that includes conditions

873

#

874

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

875

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

876

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

877

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

878

#

879

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

880

# specify any valid version or leave the field unset.

881

#

882

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

883

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

884

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

885

{ # Specifies the audit configuration for a service.

886

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

887

# identities, if any, are exempted from logging.

888

# An AuditConfig must have one or more AuditLogConfigs.

889

#

890

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

891

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

892

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

893

# AuditLogConfig are exempted.

894

#

895

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

901

# "audit_log_configs": [

902

# {

903

# "log_type": "DATA_READ",

904

# "exempted_members": [

905

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

910

# },

911

# {

912

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

918

# "audit_log_configs": [

919

# {

920

# "log_type": "DATA_READ",

921

# },

922

# {

923

# "log_type": "DATA_WRITE",

924

# "exempted_members": [

925

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

934

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

935

# aliya@example.com from DATA_WRITE logging.

936

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

937

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

# Example:

#

# {

# "audit_log_configs": [

942

# {

943

# "log_type": "DATA_READ",

944

# "exempted_members": [

945

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

955

# jose@example.com from DATA_READ logging.

956

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

957

# permission.

958

# Follows the same format of Binding.members.

959

"A String",

960

],

961

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

962

},

963

],

964

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

965

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

966

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

967

},

968

],

Bu Sun Kim

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

[diff] [blame]

969

},

Bu Sun Kim

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

[diff] [blame]

970

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

971

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

972

# following default mask is used:

Dan O'Meara

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

[diff] [blame]

973

#

Bu Sun Kim

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

[diff] [blame]

974

# `paths: "bindings, etag"`

Bu Sun Kim

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

[diff] [blame]

975

}

976

977

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

984

Dan O'Meara

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

[diff] [blame]

985

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

986

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

987

#

988

#

Dan O'Meara

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

[diff] [blame]

989

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

990

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

991

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

992

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

993

# custom role.

Bu Sun Kim

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

[diff] [blame]

994

#

Bu Sun Kim

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

[diff] [blame]

995

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

996

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

997

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

998

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

999

# resources support conditions in their IAM policies, see the

1000

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

Dan O'Meara

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

[diff] [blame]

1001

#

1002

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1003

#

1004

# {

Bu Sun Kim

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

[diff] [blame]

1005

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

1006

# {

Bu Sun Kim

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

[diff] [blame]

1007

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

1008

# "members": [

1009

# "user:mike@example.com",

1010

# "group:admins@example.com",

1011

# "domain:google.com",

1012

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

Bu Sun Kim

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

[diff] [blame]

1013

# ]

1014

# },

1015

# {

Bu Sun Kim

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

[diff] [blame]

1016

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

1017

# "members": [

1018

# "user:eve@example.com"

1019

# ],

1020

# "condition": {

1021

# "title": "expirable access",

1022

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

1023

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

Dan O'Meara

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

[diff] [blame]

1024

# }

Bu Sun Kim

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

[diff] [blame]

1025

# }

Dan O'Meara

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

[diff] [blame]

1026

# ],

Bu Sun Kim

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

[diff] [blame]

1027

# "etag": "BwWWja0YfJA=",

1028

# "version": 3

Bu Sun Kim

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

[diff] [blame]

1029

# }

1030

#

Dan O'Meara

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

[diff] [blame]

1031

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1036

# - group:admins@example.com

1037

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1038

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

1039

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1040

# - members:

Dan O'Meara

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

[diff] [blame]

1041

# - user:eve@example.com

1042

# role: roles/resourcemanager.organizationViewer

1043

# condition:

1044

# title: expirable access

1045

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1046

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

Dan O'Meara

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

[diff] [blame]

1047

# - etag: BwWWja0YfJA=

1048

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1049

#

1050

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

Dan O'Meara

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

[diff] [blame]

1051

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

Bu Sun Kim

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

[diff] [blame]

1052

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

1053

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

1054

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

1055

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

Bu Sun Kim

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

[diff] [blame]

1056

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

1057

#

1058

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

1059

# current request.

1060

#

1061

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

1062

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

1063

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

1064

#

1065

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

1066

# [IAM

1067

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

Dan O'Meara

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

[diff] [blame]

1068

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

1069

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

1070

#

1071

# Example (Comparison):

1072

#

Bu Sun Kim

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

[diff] [blame]

1073

# title: "Summary size limit"

1074

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

1075

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

Dan O'Meara

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

[diff] [blame]

1076

#

1077

# Example (Equality):

1078

#

Bu Sun Kim

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

[diff] [blame]

1079

# title: "Requestor is owner"

1080

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

1081

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

Dan O'Meara

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

[diff] [blame]

1082

#

1083

# Example (Logic):

1084

#

Bu Sun Kim

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

[diff] [blame]

1085

# title: "Public documents"

1086

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

1087

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

Dan O'Meara

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

[diff] [blame]

1088

#

1089

# Example (Data Manipulation):

1090

#

Bu Sun Kim

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

[diff] [blame]

1091

# title: "Notification string"

1092

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

1093

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

Dan O'Meara

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

[diff] [blame]

1094

#

1095

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

1096

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

1097

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

1098

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

Dan O'Meara

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

[diff] [blame]

1099

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

Bu Sun Kim

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

[diff] [blame]

1100

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

Dan O'Meara

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

[diff] [blame]

1101

# syntax.

Bu Sun Kim

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

[diff] [blame]

1102

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

Dan O'Meara

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

[diff] [blame]

1103

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

1104

# expression.

Bu Sun Kim

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

[diff] [blame]

1105

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

1106

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

Dan O'Meara

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

[diff] [blame]

1107

},

Bu Sun Kim

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

[diff] [blame]

1108

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

Dan O'Meara

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

[diff] [blame]

1109

# `members` can have the following values:

1110

#

1111

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

1112

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

1113

#

1114

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

1115

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

1116

#

1117

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

1118

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

1119

#

1120

#

1121

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

1122

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

1123

#

1124

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

1125

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

1126

#

1127

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

1128

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

1129

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

1130

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

1131

# retains the role in the binding.

1132

#

1133

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

1134

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

1135

# deleted. For example,

1136

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

1137

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

1138

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

1139

# role in the binding.

1140

#

1141

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

1142

# identifier) representing a Google group that has been recently

1143

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

1144

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

1145

# recovered group retains the role in the binding.

1146

#

1147

#

1148

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

1149

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

1150

#

Bu Sun Kim

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

[diff] [blame]

1151

"A String",

Dan O'Meara

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

[diff] [blame]

1152

],

Bu Sun Kim

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

[diff] [blame]

1153

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

1154

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

Dan O'Meara

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

[diff] [blame]

1155

},

1156

],

Bu Sun Kim

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

[diff] [blame]

1157

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

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

1164

#

1165

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

1166

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

1167

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

1168

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

Bu Sun Kim

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

[diff] [blame]

1169

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

1170

#

1171

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

1172

# are rejected.

1173

#

1174

# Any operation that affects conditional role bindings must specify version

1175

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

1176

#

1177

# * Getting a policy that includes a conditional role binding

1178

# * Adding a conditional role binding to a policy

1179

# * Changing a conditional role binding in a policy

1180

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

1181

# that includes conditions

1182

#

1183

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

1184

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

1185

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

1186

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

1187

#

1188

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

1189

# specify any valid version or leave the field unset.

1190

#

1191

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

1192

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

1193

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

1194

{ # Specifies the audit configuration for a service.

1195

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

1196

# identities, if any, are exempted from logging.

1197

# An AuditConfig must have one or more AuditLogConfigs.

1198

#

1199

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

1200

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

1201

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

1202

# AuditLogConfig are exempted.

1203

#

1204

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1210

# "audit_log_configs": [

1211

# {

1212

# "log_type": "DATA_READ",

1213

# "exempted_members": [

1214

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1219

# },

1220

# {

1221

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

1227

# "audit_log_configs": [

1228

# {

1229

# "log_type": "DATA_READ",

1230

# },

1231

# {

1232

# "log_type": "DATA_WRITE",

1233

# "exempted_members": [

1234

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

1243

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

1244

# aliya@example.com from DATA_WRITE logging.

1245

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

1246

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

# Example:

#

# {

# "audit_log_configs": [

1251

# {

1252

# "log_type": "DATA_READ",

1253

# "exempted_members": [

1254

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1264

# jose@example.com from DATA_READ logging.

1265

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

1266

# permission.

1267

# Follows the same format of Binding.members.

1268

"A String",

1269

],

1270

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

1271

},

1272

],

1273

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

1274

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

1275

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

1276

},

1277

],

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]

1282

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

1283

<pre>Tests the access control policy for a billing account. This method takes

1284

the resource and a set of permissions as input and returns the subset of

1285

the input permissions that the caller is allowed for that resource.

1286

1287

Args:

1288

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

1289

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

Dan O'Meara

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

[diff] [blame]

1290

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1291

The object takes the form of:

1292

1293

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1294

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

1295

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

Bu Sun Kim

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

[diff] [blame]

1296

# information see

1297

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

Bu Sun Kim

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

[diff] [blame]

1298

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

1309

1310

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1311

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

Bu Sun Kim

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

[diff] [blame]

1312

# allowed.

Bu Sun Kim

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

[diff] [blame]

1313

"A String",

Bu Sun Kim