docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/secretmanager_v1beta1.projects.secrets.html b/docs/dyn/secretmanager_v1beta1.projects.secrets.html
index 5859fbd..357adbb 100644
--- a/docs/dyn/secretmanager_v1beta1.projects.secrets.html
+++ b/docs/dyn/secretmanager_v1beta1.projects.secrets.html
@@ -81,7 +81,10 @@
<p class="toc_element">
<code><a href="#addVersion">addVersion(parent, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a new SecretVersion containing secret data and attaches</p>
+<p class="firstline">Creates a new SecretVersion containing secret data and attaches it to an existing Secret.</p>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, secretId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Secret containing no SecretVersions.</p>
@@ -93,7 +96,7 @@
<p class="firstline">Gets metadata for a given Secret.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the access control policy for a secret.</p>
+<p class="firstline">Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Secrets.</p>
@@ -105,25 +108,22 @@
<p class="firstline">Updates metadata of an existing Secret.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Sets the access control policy on the specified secret. Replaces any</p>
+<p class="firstline">Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns permissions that a caller has for the specified secret.</p>
+<p class="firstline">Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addVersion">addVersion(parent, body=None, x__xgafv=None)</code>
- <pre>Creates a new SecretVersion containing secret data and attaches
-it to an existing Secret.
+ <pre>Creates a new SecretVersion containing secret data and attaches it to an existing Secret.
Args:
- parent: string, Required. The resource name of the Secret to associate with the
-SecretVersion in the format `projects/*/secrets/*`. (required)
+ parent: string, Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for SecretManagerService.AddSecretVersion.
- "payload": { # A secret payload resource in the Secret Manager API. This contains the # Required. The secret payload of the SecretVersion.
- # sensitive secret data that is associated with a SecretVersion.
+ "payload": { # A secret payload resource in the Secret Manager API. This contains the sensitive secret data that is associated with a SecretVersion. # Required. The secret payload of the SecretVersion.
"data": "A String", # The secret data. Must be no larger than 64KiB.
},
}
@@ -137,74 +137,47 @@
An object of the form:
{ # A secret version resource in the Secret Manager API.
+ "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
"createTime": "A String", # Output only. The time at which the SecretVersion was created.
- "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed.
- # Only present if state is
- # DESTROYED.
- "name": "A String", # Output only. The resource name of the SecretVersion in the
- # format `projects/*/secrets/*/versions/*`.
- #
- # SecretVersion IDs in a Secret start at 1 and
- # are incremented for each subsequent version of the secret.
"state": "A String", # Output only. The current state of the SecretVersion.
+ "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
}</pre>
</div>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="create">create(parent, body=None, secretId=None, x__xgafv=None)</code>
<pre>Creates a new Secret containing no SecretVersions.
Args:
- parent: string, Required. The resource name of the project to associate with the
-Secret, in the format `projects/*`. (required)
+ parent: string, Required. The resource name of the project to associate with the Secret, in the format `projects/*`. (required)
body: object, The request body.
The object takes the form of:
-{ # A Secret is a logical secret whose value and versions can
- # be accessed.
- #
- # A Secret is made up of zero or more SecretVersions that
- # represent the secret data.
+{ # A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.
"name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`.
- "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret.
- #
- # The replication policy cannot be changed after the Secret has been created.
- "userManaged": { # A replication policy that replicates the Secret payload into the # The Secret will only be replicated into the locations specified.
- # locations specified in Secret.replication.user_managed.replicas
- "replicas": [ # Required. The list of Replicas for this Secret.
- #
- # Cannot be empty.
+ "createTime": "A String", # Output only. The time at which the Secret was created.
+ "labels": { # The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource.
+ "a_key": "A String",
+ },
+ "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
+ "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions.
+ },
+ "userManaged": { # A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas # The Secret will only be replicated into the locations specified.
+ "replicas": [ # Required. The list of Replicas for this Secret. Cannot be empty.
{ # Represents a Replica for this Secret.
- "location": "A String", # The canonical IDs of the location to replicate data.
- # For example: `"us-east1"`.
+ "location": "A String", # The canonical IDs of the location to replicate data. For example: `"us-east1"`.
},
],
},
- "automatic": { # A replication policy that replicates the Secret payload without any # The Secret will automatically be replicated without any restrictions.
- # restrictions.
- },
},
- "labels": { # The labels assigned to this Secret.
- #
- # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
- # of maximum 128 bytes, and must conform to the following PCRE regular
- # expression: `\p{Ll}\p{Lo}{0,62}`
- #
- # Label values must be between 0 and 63 characters long, have a UTF-8
- # encoding of maximum 128 bytes, and must conform to the following PCRE
- # regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`
- #
- # No more than 64 labels can be assigned to a given resource.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which the Secret was created.
}
- secretId: string, Required. This must be unique within the project.
-
-A secret ID is a string with a maximum length of 255 characters and can
-contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and
-underscore (`_`) characters.
+ secretId: string, Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -213,44 +186,23 @@
Returns:
An object of the form:
- { # A Secret is a logical secret whose value and versions can
- # be accessed.
- #
- # A Secret is made up of zero or more SecretVersions that
- # represent the secret data.
+ { # A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.
"name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`.
- "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret.
- #
- # The replication policy cannot be changed after the Secret has been created.
- "userManaged": { # A replication policy that replicates the Secret payload into the # The Secret will only be replicated into the locations specified.
- # locations specified in Secret.replication.user_managed.replicas
- "replicas": [ # Required. The list of Replicas for this Secret.
- #
- # Cannot be empty.
+ "createTime": "A String", # Output only. The time at which the Secret was created.
+ "labels": { # The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource.
+ "a_key": "A String",
+ },
+ "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
+ "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions.
+ },
+ "userManaged": { # A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas # The Secret will only be replicated into the locations specified.
+ "replicas": [ # Required. The list of Replicas for this Secret. Cannot be empty.
{ # Represents a Replica for this Secret.
- "location": "A String", # The canonical IDs of the location to replicate data.
- # For example: `"us-east1"`.
+ "location": "A String", # The canonical IDs of the location to replicate data. For example: `"us-east1"`.
},
],
},
- "automatic": { # A replication policy that replicates the Secret payload without any # The Secret will automatically be replicated without any restrictions.
- # restrictions.
- },
},
- "labels": { # The labels assigned to this Secret.
- #
- # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
- # of maximum 128 bytes, and must conform to the following PCRE regular
- # expression: `\p{Ll}\p{Lo}{0,62}`
- #
- # Label values must be between 0 and 63 characters long, have a UTF-8
- # encoding of maximum 128 bytes, and must conform to the following PCRE
- # regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`
- #
- # No more than 64 labels can be assigned to a given resource.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which the Secret was created.
}</pre>
</div>
@@ -259,8 +211,7 @@
<pre>Deletes a Secret.
Args:
- name: string, Required. The resource name of the Secret to delete in the format
-`projects/*/secrets/*`. (required)
+ name: string, Required. The resource name of the Secret to delete in the format `projects/*/secrets/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -269,15 +220,7 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated
- # empty messages in your APIs. A typical example is to use it as the request
- # or the response type of an API method. For instance:
- #
- # service Foo {
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- # }
- #
- # The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
@@ -295,67 +238,33 @@
Returns:
An object of the form:
- { # A Secret is a logical secret whose value and versions can
- # be accessed.
- #
- # A Secret is made up of zero or more SecretVersions that
- # represent the secret data.
+ { # A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.
"name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`.
- "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret.
- #
- # The replication policy cannot be changed after the Secret has been created.
- "userManaged": { # A replication policy that replicates the Secret payload into the # The Secret will only be replicated into the locations specified.
- # locations specified in Secret.replication.user_managed.replicas
- "replicas": [ # Required. The list of Replicas for this Secret.
- #
- # Cannot be empty.
+ "createTime": "A String", # Output only. The time at which the Secret was created.
+ "labels": { # The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource.
+ "a_key": "A String",
+ },
+ "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
+ "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions.
+ },
+ "userManaged": { # A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas # The Secret will only be replicated into the locations specified.
+ "replicas": [ # Required. The list of Replicas for this Secret. Cannot be empty.
{ # Represents a Replica for this Secret.
- "location": "A String", # The canonical IDs of the location to replicate data.
- # For example: `"us-east1"`.
+ "location": "A String", # The canonical IDs of the location to replicate data. For example: `"us-east1"`.
},
],
},
- "automatic": { # A replication policy that replicates the Secret payload without any # The Secret will automatically be replicated without any restrictions.
- # restrictions.
- },
},
- "labels": { # The labels assigned to this Secret.
- #
- # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
- # of maximum 128 bytes, and must conform to the following PCRE regular
- # expression: `\p{Ll}\p{Lo}{0,62}`
- #
- # Label values must be between 0 and 63 characters long, have a UTF-8
- # encoding of maximum 128 bytes, and must conform to the following PCRE
- # regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`
- #
- # No more than 64 labels can be assigned to a given resource.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which the Secret was created.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
- <pre>Gets the access control policy for a secret.
-Returns empty policy if the secret exists and does not have a policy set.
+ <pre>Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.
Args:
- resource: string, REQUIRED: The resource for which the policy is being requested.
-See the operation documentation for the appropriate value for this field. (required)
- options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.
-
-Valid values are 0, 1, and 3. Requests specifying an invalid value will be
-rejected.
-
-Requests for policies with any conditional bindings must specify version 3.
-Policies without any conditional bindings may specify any valid value or
-leave the field unset.
-
-To learn which resources support conditions in their IAM policies, see the
-[IAM
-documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -364,299 +273,37 @@
Returns:
An object of the form:
- { # An Identity and Access Management (IAM) policy, which specifies access
- # controls for Google Cloud resources.
- #
- #
- # A `Policy` is a collection of `bindings`. A `binding` binds one or more
- # `members` to a single `role`. Members can be user accounts, service accounts,
- # Google groups, and domains (such as G Suite). A `role` is a named list of
- # permissions; each `role` can be an IAM predefined role or a user-created
- # custom role.
- #
- # For some types of Google Cloud resources, a `binding` can also specify a
- # `condition`, which is a logical expression that allows access to a resource
- # only if the expression evaluates to `true`. A condition can add constraints
- # based on attributes of the request, the resource, or both. To learn which
- # resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- #
- # **JSON example:**
- #
- # {
- # "bindings": [
- # {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
- # ]
- # },
- # {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": [
- # "user:eve@example.com"
- # ],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
- # }
- # }
- # ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
- # }
- #
- # **YAML example:**
- #
- # bindings:
- # - members:
- # - user:mike@example.com
- # - group:admins@example.com
- # - domain:google.com
- # - serviceAccount:my-project-id@appspot.gserviceaccount.com
- # role: roles/resourcemanager.organizationAdmin
- # - members:
- # - user:eve@example.com
- # role: roles/resourcemanager.organizationViewer
- # condition:
- # title: expirable access
- # description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
- # - etag: BwWWja0YfJA=
- # - version: 3
- #
- # For a description of IAM and its features, see the
- # [IAM documentation](https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service.
- # The configuration determines which permission types are logged, and what
- # identities, if any, are exempted from logging.
- # An AuditConfig must have one or more AuditLogConfigs.
- #
- # If there are AuditConfigs for both `allServices` and a specific service,
- # the union of the two AuditConfigs is used for that service: the log_types
- # specified in each AuditConfig are enabled, and the exempted_members in each
- # AuditLogConfig are exempted.
- #
- # Example Policy with multiple AuditConfigs:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices",
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE"
- # },
- # {
- # "log_type": "ADMIN_READ"
- # }
- # ]
- # },
- # {
- # "service": "sampleservice.googleapis.com",
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ"
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:aliya@example.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts jose@example.com from DATA_READ logging, and
- # aliya@example.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE"
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # jose@example.com from DATA_READ logging.
- "logType": "A String", # The log type that this config enables.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- # `allServices` is a special value that covers all services.
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
- # `condition` that determines how and when the `bindings` are applied. Each
- # of the `bindings` must contain at least one member.
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
- # `members` can have the following values:
- #
- # * `allUsers`: A special identifier that represents anyone who is
- # on the internet; with or without a Google account.
- #
- # * `allAuthenticatedUsers`: A special identifier that represents anyone
- # who is authenticated with a Google account or a service account.
- #
- # * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@example.com` .
- #
- #
- # * `serviceAccount:{emailid}`: An email address that represents a service
- # account. For example, `my-other-app@appspot.gserviceaccount.com`.
- #
- # * `group:{emailid}`: An email address that represents a Google group.
- # For example, `admins@example.com`.
- #
- # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
- # identifier) representing a user that has been recently deleted. For
- # example, `alice@example.com?uid=123456789012345678901`. If the user is
- # recovered, this value reverts to `user:{emailid}` and the recovered user
- # retains the role in the binding.
- #
- # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
- # unique identifier) representing a service account that has been recently
- # deleted. For example,
- # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
- # If the service account is undeleted, this value reverts to
- # `serviceAccount:{emailid}` and the undeleted service account retains the
- # role in the binding.
- #
- # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
- # identifier) representing a Google group that has been recently
- # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
- # the group is recovered, this value reverts to `group:{emailid}` and the
- # recovered group retains the role in the binding.
- #
- #
- # * `domain:{domain}`: The G Suite domain (primary) that represents all the
- # users of that domain. For example, `google.com` or `example.com`.
- #
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
}</pre>
</div>
@@ -665,13 +312,9 @@
<pre>Lists Secrets.
Args:
- parent: string, Required. The resource name of the project associated with the
-Secrets, in the format `projects/*`. (required)
- pageSize: integer, Optional. The maximum number of results to be returned in a single page. If
-set to 0, the server decides the number of results to return. If the
-number is greater than 25000, it is capped at 25000.
- pageToken: string, Optional. Pagination token, returned earlier via
-ListSecretsResponse.next_page_token.
+ parent: string, Required. The resource name of the project associated with the Secrets, in the format `projects/*`. (required)
+ pageSize: integer, Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.
+ pageToken: string, Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -681,51 +324,28 @@
An object of the form:
{ # Response message for SecretManagerService.ListSecrets.
- "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in
- # ListSecretsRequest.page_token to retrieve the next page.
- "totalSize": 42, # The total number of Secrets.
- "secrets": [ # The list of Secrets sorted in reverse by create_time (newest
- # first).
- { # A Secret is a logical secret whose value and versions can
- # be accessed.
- #
- # A Secret is made up of zero or more SecretVersions that
- # represent the secret data.
+ "secrets": [ # The list of Secrets sorted in reverse by create_time (newest first).
+ { # A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.
"name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`.
- "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret.
- #
- # The replication policy cannot be changed after the Secret has been created.
- "userManaged": { # A replication policy that replicates the Secret payload into the # The Secret will only be replicated into the locations specified.
- # locations specified in Secret.replication.user_managed.replicas
- "replicas": [ # Required. The list of Replicas for this Secret.
- #
- # Cannot be empty.
+ "createTime": "A String", # Output only. The time at which the Secret was created.
+ "labels": { # The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource.
+ "a_key": "A String",
+ },
+ "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
+ "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions.
+ },
+ "userManaged": { # A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas # The Secret will only be replicated into the locations specified.
+ "replicas": [ # Required. The list of Replicas for this Secret. Cannot be empty.
{ # Represents a Replica for this Secret.
- "location": "A String", # The canonical IDs of the location to replicate data.
- # For example: `"us-east1"`.
+ "location": "A String", # The canonical IDs of the location to replicate data. For example: `"us-east1"`.
},
],
},
- "automatic": { # A replication policy that replicates the Secret payload without any # The Secret will automatically be replicated without any restrictions.
- # restrictions.
- },
},
- "labels": { # The labels assigned to this Secret.
- #
- # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
- # of maximum 128 bytes, and must conform to the following PCRE regular
- # expression: `\p{Ll}\p{Lo}{0,62}`
- #
- # Label values must be between 0 and 63 characters long, have a UTF-8
- # encoding of maximum 128 bytes, and must conform to the following PCRE
- # regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`
- #
- # No more than 64 labels can be assigned to a given resource.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which the Secret was created.
},
],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in ListSecretsRequest.page_token to retrieve the next page.
+ "totalSize": 42, # The total number of Secrets.
}</pre>
</div>
@@ -752,44 +372,23 @@
body: object, The request body.
The object takes the form of:
-{ # A Secret is a logical secret whose value and versions can
- # be accessed.
- #
- # A Secret is made up of zero or more SecretVersions that
- # represent the secret data.
+{ # A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.
"name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`.
- "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret.
- #
- # The replication policy cannot be changed after the Secret has been created.
- "userManaged": { # A replication policy that replicates the Secret payload into the # The Secret will only be replicated into the locations specified.
- # locations specified in Secret.replication.user_managed.replicas
- "replicas": [ # Required. The list of Replicas for this Secret.
- #
- # Cannot be empty.
+ "createTime": "A String", # Output only. The time at which the Secret was created.
+ "labels": { # The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource.
+ "a_key": "A String",
+ },
+ "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
+ "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions.
+ },
+ "userManaged": { # A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas # The Secret will only be replicated into the locations specified.
+ "replicas": [ # Required. The list of Replicas for this Secret. Cannot be empty.
{ # Represents a Replica for this Secret.
- "location": "A String", # The canonical IDs of the location to replicate data.
- # For example: `"us-east1"`.
+ "location": "A String", # The canonical IDs of the location to replicate data. For example: `"us-east1"`.
},
],
},
- "automatic": { # A replication policy that replicates the Secret payload without any # The Secret will automatically be replicated without any restrictions.
- # restrictions.
- },
},
- "labels": { # The labels assigned to this Secret.
- #
- # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
- # of maximum 128 bytes, and must conform to the following PCRE regular
- # expression: `\p{Ll}\p{Lo}{0,62}`
- #
- # Label values must be between 0 and 63 characters long, have a UTF-8
- # encoding of maximum 128 bytes, and must conform to the following PCRE
- # regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`
- #
- # No more than 64 labels can be assigned to a given resource.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which the Secret was created.
}
updateMask: string, Required. Specifies the fields to be updated.
@@ -801,364 +400,69 @@
Returns:
An object of the form:
- { # A Secret is a logical secret whose value and versions can
- # be accessed.
- #
- # A Secret is made up of zero or more SecretVersions that
- # represent the secret data.
+ { # A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.
"name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`.
- "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret.
- #
- # The replication policy cannot be changed after the Secret has been created.
- "userManaged": { # A replication policy that replicates the Secret payload into the # The Secret will only be replicated into the locations specified.
- # locations specified in Secret.replication.user_managed.replicas
- "replicas": [ # Required. The list of Replicas for this Secret.
- #
- # Cannot be empty.
+ "createTime": "A String", # Output only. The time at which the Secret was created.
+ "labels": { # The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource.
+ "a_key": "A String",
+ },
+ "replication": { # A policy that defines the replication configuration of data. # Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
+ "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions.
+ },
+ "userManaged": { # A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas # The Secret will only be replicated into the locations specified.
+ "replicas": [ # Required. The list of Replicas for this Secret. Cannot be empty.
{ # Represents a Replica for this Secret.
- "location": "A String", # The canonical IDs of the location to replicate data.
- # For example: `"us-east1"`.
+ "location": "A String", # The canonical IDs of the location to replicate data. For example: `"us-east1"`.
},
],
},
- "automatic": { # A replication policy that replicates the Secret payload without any # The Secret will automatically be replicated without any restrictions.
- # restrictions.
- },
},
- "labels": { # The labels assigned to this Secret.
- #
- # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
- # of maximum 128 bytes, and must conform to the following PCRE regular
- # expression: `\p{Ll}\p{Lo}{0,62}`
- #
- # Label values must be between 0 and 63 characters long, have a UTF-8
- # encoding of maximum 128 bytes, and must conform to the following PCRE
- # regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`
- #
- # No more than 64 labels can be assigned to a given resource.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which the Secret was created.
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
- <pre>Sets the access control policy on the specified secret. Replaces any
-existing policy.
-
-Permissions on SecretVersions are enforced according
-to the policy set on the associated Secret.
+ <pre>Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.
Args:
- resource: string, REQUIRED: The resource for which the policy is being specified.
-See the operation documentation for the appropriate value for this field. (required)
+ resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
- # the policy is limited to a few 10s of KB. An empty policy is a
- # valid policy but certain Cloud Platform services (such as Projects)
- # might reject them.
- # controls for Google Cloud resources.
- #
- #
- # A `Policy` is a collection of `bindings`. A `binding` binds one or more
- # `members` to a single `role`. Members can be user accounts, service accounts,
- # Google groups, and domains (such as G Suite). A `role` is a named list of
- # permissions; each `role` can be an IAM predefined role or a user-created
- # custom role.
- #
- # For some types of Google Cloud resources, a `binding` can also specify a
- # `condition`, which is a logical expression that allows access to a resource
- # only if the expression evaluates to `true`. A condition can add constraints
- # based on attributes of the request, the resource, or both. To learn which
- # resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- #
- # **JSON example:**
- #
- # {
- # "bindings": [
- # {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
- # ]
- # },
- # {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": [
- # "user:eve@example.com"
- # ],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
- # }
- # }
- # ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
- # }
- #
- # **YAML example:**
- #
- # bindings:
- # - members:
- # - user:mike@example.com
- # - group:admins@example.com
- # - domain:google.com
- # - serviceAccount:my-project-id@appspot.gserviceaccount.com
- # role: roles/resourcemanager.organizationAdmin
- # - members:
- # - user:eve@example.com
- # role: roles/resourcemanager.organizationViewer
- # condition:
- # title: expirable access
- # description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
- # - etag: BwWWja0YfJA=
- # - version: 3
- #
- # For a description of IAM and its features, see the
- # [IAM documentation](https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service.
- # The configuration determines which permission types are logged, and what
- # identities, if any, are exempted from logging.
- # An AuditConfig must have one or more AuditLogConfigs.
- #
- # If there are AuditConfigs for both `allServices` and a specific service,
- # the union of the two AuditConfigs is used for that service: the log_types
- # specified in each AuditConfig are enabled, and the exempted_members in each
- # AuditLogConfig are exempted.
- #
- # Example Policy with multiple AuditConfigs:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices",
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE"
- # },
- # {
- # "log_type": "ADMIN_READ"
- # }
- # ]
- # },
- # {
- # "service": "sampleservice.googleapis.com",
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ"
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:aliya@example.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts jose@example.com from DATA_READ logging, and
- # aliya@example.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE"
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # jose@example.com from DATA_READ logging.
- "logType": "A String", # The log type that this config enables.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- # `allServices` is a special value that covers all services.
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
- # `condition` that determines how and when the `bindings` are applied. Each
- # of the `bindings` must contain at least one member.
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
- # `members` can have the following values:
- #
- # * `allUsers`: A special identifier that represents anyone who is
- # on the internet; with or without a Google account.
- #
- # * `allAuthenticatedUsers`: A special identifier that represents anyone
- # who is authenticated with a Google account or a service account.
- #
- # * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@example.com` .
- #
- #
- # * `serviceAccount:{emailid}`: An email address that represents a service
- # account. For example, `my-other-app@appspot.gserviceaccount.com`.
- #
- # * `group:{emailid}`: An email address that represents a Google group.
- # For example, `admins@example.com`.
- #
- # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
- # identifier) representing a user that has been recently deleted. For
- # example, `alice@example.com?uid=123456789012345678901`. If the user is
- # recovered, this value reverts to `user:{emailid}` and the recovered user
- # retains the role in the binding.
- #
- # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
- # unique identifier) representing a service account that has been recently
- # deleted. For example,
- # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
- # If the service account is undeleted, this value reverts to
- # `serviceAccount:{emailid}` and the undeleted service account retains the
- # role in the binding.
- #
- # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
- # identifier) representing a Google group that has been recently
- # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
- # the group is recovered, this value reverts to `group:{emailid}` and the
- # recovered group retains the role in the binding.
- #
- #
- # * `domain:{domain}`: The G Suite domain (primary) that represents all the
- # users of that domain. For example, `google.com` or `example.com`.
- #
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
},
- "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, the
- # following default mask is used:
- #
- # `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
@@ -1169,323 +473,51 @@
Returns:
An object of the form:
- { # An Identity and Access Management (IAM) policy, which specifies access
- # controls for Google Cloud resources.
- #
- #
- # A `Policy` is a collection of `bindings`. A `binding` binds one or more
- # `members` to a single `role`. Members can be user accounts, service accounts,
- # Google groups, and domains (such as G Suite). A `role` is a named list of
- # permissions; each `role` can be an IAM predefined role or a user-created
- # custom role.
- #
- # For some types of Google Cloud resources, a `binding` can also specify a
- # `condition`, which is a logical expression that allows access to a resource
- # only if the expression evaluates to `true`. A condition can add constraints
- # based on attributes of the request, the resource, or both. To learn which
- # resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- #
- # **JSON example:**
- #
- # {
- # "bindings": [
- # {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
- # ]
- # },
- # {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": [
- # "user:eve@example.com"
- # ],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
- # }
- # }
- # ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
- # }
- #
- # **YAML example:**
- #
- # bindings:
- # - members:
- # - user:mike@example.com
- # - group:admins@example.com
- # - domain:google.com
- # - serviceAccount:my-project-id@appspot.gserviceaccount.com
- # role: roles/resourcemanager.organizationAdmin
- # - members:
- # - user:eve@example.com
- # role: roles/resourcemanager.organizationViewer
- # condition:
- # title: expirable access
- # description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
- # - etag: BwWWja0YfJA=
- # - version: 3
- #
- # For a description of IAM and its features, see the
- # [IAM documentation](https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service.
- # The configuration determines which permission types are logged, and what
- # identities, if any, are exempted from logging.
- # An AuditConfig must have one or more AuditLogConfigs.
- #
- # If there are AuditConfigs for both `allServices` and a specific service,
- # the union of the two AuditConfigs is used for that service: the log_types
- # specified in each AuditConfig are enabled, and the exempted_members in each
- # AuditLogConfig are exempted.
- #
- # Example Policy with multiple AuditConfigs:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices",
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE"
- # },
- # {
- # "log_type": "ADMIN_READ"
- # }
- # ]
- # },
- # {
- # "service": "sampleservice.googleapis.com",
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ"
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:aliya@example.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts jose@example.com from DATA_READ logging, and
- # aliya@example.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE"
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # jose@example.com from DATA_READ logging.
- "logType": "A String", # The log type that this config enables.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- # `allServices` is a special value that covers all services.
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
- # `condition` that determines how and when the `bindings` are applied. Each
- # of the `bindings` must contain at least one member.
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
- # `members` can have the following values:
- #
- # * `allUsers`: A special identifier that represents anyone who is
- # on the internet; with or without a Google account.
- #
- # * `allAuthenticatedUsers`: A special identifier that represents anyone
- # who is authenticated with a Google account or a service account.
- #
- # * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@example.com` .
- #
- #
- # * `serviceAccount:{emailid}`: An email address that represents a service
- # account. For example, `my-other-app@appspot.gserviceaccount.com`.
- #
- # * `group:{emailid}`: An email address that represents a Google group.
- # For example, `admins@example.com`.
- #
- # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
- # identifier) representing a user that has been recently deleted. For
- # example, `alice@example.com?uid=123456789012345678901`. If the user is
- # recovered, this value reverts to `user:{emailid}` and the recovered user
- # retains the role in the binding.
- #
- # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
- # unique identifier) representing a service account that has been recently
- # deleted. For example,
- # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
- # If the service account is undeleted, this value reverts to
- # `serviceAccount:{emailid}` and the undeleted service account retains the
- # role in the binding.
- #
- # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
- # identifier) representing a Google group that has been recently
- # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
- # the group is recovered, this value reverts to `group:{emailid}` and the
- # recovered group retains the role in the binding.
- #
- #
- # * `domain:{domain}`: The G Suite domain (primary) that represents all the
- # users of that domain. For example, `google.com` or `example.com`.
- #
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
+ "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
- <pre>Returns permissions that a caller has for the specified secret.
-If the secret does not exist, this call returns an empty set of
-permissions, not a NOT_FOUND error.
-
-Note: This operation is designed to be used for building permission-aware
-UIs and command-line tools, not for authorization checking. This operation
-may "fail open" without warning.
+ <pre>Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Args:
- resource: string, REQUIRED: The resource for which the policy detail is being requested.
-See the operation documentation for the appropriate value for this field. (required)
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
- # information see
- # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
@@ -1499,8 +531,7 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
- # allowed.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}</pre>