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

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

[diff] [blame]

679

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

680

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

681

# might reject them.

Dan O'Meara

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

[diff] [blame]

682

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

683

#

684

#

Dan O'Meara

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

[diff] [blame]

685

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

686

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

687

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

688

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

689

# custom role.

Bu Sun Kim

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

[diff] [blame]

690

#

Bu Sun Kim

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

[diff] [blame]

691

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

692

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

693

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

694

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

695

# resources support conditions in their IAM policies, see the

696

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

Dan O'Meara

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

[diff] [blame]

697

#

698

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

699

#

700

# {

Bu Sun Kim

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

[diff] [blame]

701

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

702

# {

Bu Sun Kim

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

[diff] [blame]

703

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

704

# "members": [

705

# "user:mike@example.com",

706

# "group:admins@example.com",

707

# "domain:google.com",

708

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

Bu Sun Kim

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

[diff] [blame]

709

# ]

710

# },

711

# {

Bu Sun Kim

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

[diff] [blame]

712

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

713

# "members": [

714

# "user:eve@example.com"

715

# ],

716

# "condition": {

717

# "title": "expirable access",

718

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

719

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

Dan O'Meara

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

[diff] [blame]

720

# }

Bu Sun Kim

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

[diff] [blame]

721

# }

Dan O'Meara

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

[diff] [blame]

722

# ],

Bu Sun Kim

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

[diff] [blame]

723

# "etag": "BwWWja0YfJA=",

724

# "version": 3

Bu Sun Kim

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

[diff] [blame]

725

# }

726

#

Dan O'Meara

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

[diff] [blame]

727

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

732

# - group:admins@example.com

733

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

734

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

735

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

736

# - members:

Dan O'Meara

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

[diff] [blame]

737

# - user:eve@example.com

738

# role: roles/resourcemanager.organizationViewer

739

# condition:

740

# title: expirable access

741

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

742

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

Dan O'Meara

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

[diff] [blame]

743

# - etag: BwWWja0YfJA=

744

# - version: 3

Bu Sun Kim

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

[diff] [blame]

745

#

746

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

Dan O'Meara

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

[diff] [blame]

747

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

Bu Sun Kim

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

[diff] [blame]

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

#

756

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

757

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

758

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

759

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

760

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

761

#

762

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

763

# are rejected.

764

#

765

# Any operation that affects conditional role bindings must specify version

766

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

767

#

768

# * Getting a policy that includes a conditional role binding

769

# * Adding a conditional role binding to a policy

770

# * Changing a conditional role binding in a policy

771

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

772

# that includes conditions

773

#

774

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

775

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

776

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

777

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

778

#

779

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

780

# specify any valid version or leave the field unset.

781

#

782

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

783

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

Bu Sun Kim

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

[diff] [blame]

784

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

785

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

786

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

787

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

Bu Sun Kim

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

[diff] [blame]

788

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

Dan O'Meara

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

[diff] [blame]

789

# `members` can have the following values:

790

#

791

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

792

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

793

#

794

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

795

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

796

#

797

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

798

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

799

#

800

#

801

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

802

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

803

#

804

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

805

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

806

#

807

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

808

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

809

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

810

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

811

# retains the role in the binding.

812

#

813

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

814

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

815

# deleted. For example,

816

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

817

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

818

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

819

# role in the binding.

820

#

821

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

822

# identifier) representing a Google group that has been recently

823

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

824

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

825

# recovered group retains the role in the binding.

826

#

827

#

828

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

829

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

830

#

Bu Sun Kim

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

[diff] [blame]

831

"A String",

Dan O'Meara

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

[diff] [blame]

832

],

Bu Sun Kim

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

[diff] [blame]

833

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

834

#

835

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

836

# current request.

837

#

838

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

839

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

840

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

841

#

842

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

843

# [IAM

844

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

845

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

846

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

847

#

848

# Example (Comparison):

849

#

850

# title: "Summary size limit"

851

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

852

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

853

#

854

# Example (Equality):

855

#

856

# title: "Requestor is owner"

857

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

858

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

#

# Example (Logic):

#

# title: "Public documents"

863

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

864

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

865

#

866

# Example (Data Manipulation):

867

#

868

# title: "Notification string"

869

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

870

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

871

#

872

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

873

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

874

# documentation for additional information.

875

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

876

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

877

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

878

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

879

# expression.

880

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

881

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

882

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

883

# syntax.

884

},

885

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

886

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

Dan O'Meara

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

[diff] [blame]

887

},

888

],

Bu Sun Kim

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

[diff] [blame]

889

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

890

{ # Specifies the audit configuration for a service.

891

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

892

# identities, if any, are exempted from logging.

893

# An AuditConfig must have one or more AuditLogConfigs.

894

#

895

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

896

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

897

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

898

# AuditLogConfig are exempted.

899

#

900

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

Bu Sun Kim

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

[diff] [blame]

905

# "service": "allServices",

Bu Sun Kim

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

[diff] [blame]

906

# "audit_log_configs": [

907

# {

908

# "log_type": "DATA_READ",

909

# "exempted_members": [

910

# "user:jose@example.com"

911

# ]

912

# },

913

# {

Bu Sun Kim

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

[diff] [blame]

914

# "log_type": "DATA_WRITE"

Bu Sun Kim

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

[diff] [blame]

915

# },

916

# {

Bu Sun Kim

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

[diff] [blame]

917

# "log_type": "ADMIN_READ"

Bu Sun Kim

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

[diff] [blame]

# }

# ]

# },

# {

Bu Sun Kim

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

[diff] [blame]

922

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

Bu Sun Kim

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

[diff] [blame]

923

# "audit_log_configs": [

924

# {

Bu Sun Kim

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

[diff] [blame]

925

# "log_type": "DATA_READ"

Bu Sun Kim

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

[diff] [blame]

926

# },

927

# {

928

# "log_type": "DATA_WRITE",

929

# "exempted_members": [

930

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

939

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

940

# aliya@example.com from DATA_WRITE logging.

941

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

942

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

# Example:

#

# {

# "audit_log_configs": [

947

# {

948

# "log_type": "DATA_READ",

949

# "exempted_members": [

950

# "user:jose@example.com"

951

# ]

952

# },

953

# {

Bu Sun Kim

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

[diff] [blame]

954

# "log_type": "DATA_WRITE"

Bu Sun Kim

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

[diff] [blame]

# }

# ]

# }

#

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

960

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame]

961

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

Bu Sun Kim

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

[diff] [blame]

962

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

963

# permission.

964

# Follows the same format of Binding.members.

965

"A String",

966

],

Bu Sun Kim

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

[diff] [blame]

967

},

968

],

Bu Sun Kim

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

[diff] [blame]

969

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

970

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

971

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

Bu Sun Kim

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

[diff] [blame]

972

},

973

],

Bu Sun Kim

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

[diff] [blame]

974

},

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-07-22 17:02:09 -0700

[diff] [blame]

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

#

1060

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

1061

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

1062

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

1063

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

1064

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

1065

#

1066

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

1067

# are rejected.

1068

#

1069

# Any operation that affects conditional role bindings must specify version

1070

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

1071

#

1072

# * Getting a policy that includes a conditional role binding

1073

# * Adding a conditional role binding to a policy

1074

# * Changing a conditional role binding in a policy

1075

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

1076

# that includes conditions

1077

#

1078

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

1079

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

1080

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

1081

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

1082

#

1083

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

1084

# specify any valid version or leave the field unset.

1085

#

1086

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

1087

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

Bu Sun Kim

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

[diff] [blame]

1088

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

1089

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

1090

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

1091

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

Bu Sun Kim

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

[diff] [blame]

1092

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

Dan O'Meara

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

[diff] [blame]

1093

# `members` can have the following values:

1094

#

1095

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

1096

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

1097

#

1098

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

1099

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

1100

#

1101

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

1102

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

1103

#

1104

#

1105

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

1106

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

1107

#

1108

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

1109

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

1110

#

1111

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

1112

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

1113

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

1114

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

1115

# retains the role in the binding.

1116

#

1117

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

1118

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

1119

# deleted. For example,

1120

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

1121

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

1122

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

1123

# role in the binding.

1124

#

1125

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

1126

# identifier) representing a Google group that has been recently

1127

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

1128

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

1129

# recovered group retains the role in the binding.

1130

#

1131

#

1132

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

1133

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

1134

#

Bu Sun Kim

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

[diff] [blame]

1135

"A String",

Dan O'Meara

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

[diff] [blame]

1136

],

Bu Sun Kim

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

[diff] [blame]

1137

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

1138

#

1139

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

1140

# current request.

1141

#

1142

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

1143

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

1144

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

1145

#

1146

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

1147

# [IAM

1148

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

1149

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

1150

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

1151

#

1152

# Example (Comparison):

1153

#

1154

# title: "Summary size limit"

1155

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

1156

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

1157

#

1158

# Example (Equality):

1159

#

1160

# title: "Requestor is owner"

1161

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

1162

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

#

# Example (Logic):

#

# title: "Public documents"

1167

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

1168

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

1169

#

1170

# Example (Data Manipulation):

1171

#

1172

# title: "Notification string"

1173

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

1174

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

1175

#

1176

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

1177

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

1178

# documentation for additional information.

1179

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

1180

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

1181

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

1182

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

1183

# expression.

1184

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

1185

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

1186

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

1187

# syntax.

1188

},

1189

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

1190

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

Dan O'Meara

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

[diff] [blame]

1191

},

1192

],

Bu Sun Kim

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

[diff] [blame]

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

# {

Bu Sun Kim

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

[diff] [blame]

1209

# "service": "allServices",

Bu Sun Kim

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

[diff] [blame]

1210

# "audit_log_configs": [

1211

# {

1212

# "log_type": "DATA_READ",

1213

# "exempted_members": [

1214

# "user:jose@example.com"

1215

# ]

1216

# },

1217

# {

Bu Sun Kim

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

[diff] [blame]

1218

# "log_type": "DATA_WRITE"

Bu Sun Kim

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

[diff] [blame]

1219

# },

1220

# {

Bu Sun Kim

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

[diff] [blame]

1221

# "log_type": "ADMIN_READ"

Bu Sun Kim

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

[diff] [blame]

# }

# ]

# },

# {

Bu Sun Kim

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

[diff] [blame]

1226

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

Bu Sun Kim

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

[diff] [blame]

1227

# "audit_log_configs": [

1228

# {

Bu Sun Kim

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

[diff] [blame]

1229

# "log_type": "DATA_READ"

Bu Sun Kim

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

[diff] [blame]

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"

1255

# ]

1256

# },

1257

# {

Bu Sun Kim

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

[diff] [blame]

1258

# "log_type": "DATA_WRITE"

Bu Sun Kim

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

[diff] [blame]

# }

# ]

# }

#

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

1264

# jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame]

1265

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

Bu Sun Kim

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

[diff] [blame]

1266

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

1267

# permission.

1268

# Follows the same format of Binding.members.

1269

"A String",

1270

],

Bu Sun Kim

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

[diff] [blame]

1271

},

1272

],

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

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