docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/policytroubleshooter_v1beta.iam.html b/docs/dyn/policytroubleshooter_v1beta.iam.html
index 5b17a17..9cf558b 100644
--- a/docs/dyn/policytroubleshooter_v1beta.iam.html
+++ b/docs/dyn/policytroubleshooter_v1beta.iam.html
@@ -90,11 +90,6 @@
{ # Request for TroubleshootIamPolicy.
"accessTuple": { # Information about the member, resource, and permission to check. # The information to use for checking whether a member has a permission for a
# resource.
- "fullResourceName": "A String", # Required. The full resource name that identifies the resource. For example,
- # `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.
- #
- # For examples of full resource names for Google Cloud services, see
- # https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
"principal": "A String", # Required. The member, or principal, whose access you want to check, in the form of
# the email address that represents that member. For example,
# `alice@example.com` or
@@ -109,6 +104,11 @@
#
# For a complete list of predefined IAM roles and the permissions in each
# role, see https://cloud.google.com/iam/help/roles/reference.
+ "fullResourceName": "A String", # Required. The full resource name that identifies the resource. For example,
+ # `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.
+ #
+ # For examples of full resource names for Google Cloud services, see
+ # https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
},
}
@@ -133,14 +133,6 @@
# https://cloud.google.com/iam/help/resource-hierarchy.
{ # Details about how a specific IAM Policy contributed
# to the access check.
- "fullResourceName": "A String", # The full resource name that identifies the resource. For example,
- # `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.
- #
- # If the sender of the request does not have access to the policy, this field
- # is omitted.
- #
- # For examples of full resource names for Google Cloud services, see
- # https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
"access": "A String", # Indicates whether _this policy_ provides the specified permission to the
# specified member for the specified resource.
#
@@ -154,6 +146,113 @@
#
# If the sender of the request does not have access to the policy, this field
# is omitted.
+ "fullResourceName": "A String", # The full resource name that identifies the resource. For example,
+ # `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.
+ #
+ # If the sender of the request does not have access to the policy, this field
+ # is omitted.
+ #
+ # For examples of full resource names for Google Cloud services, see
+ # https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+ "bindingExplanations": [ # Details about how each binding in the policy affects the member's ability,
+ # or inability, to use the permission for the resource.
+ #
+ # If the sender of the request does not have access to the policy, this field
+ # is omitted.
+ { # Details about how a binding in a policy affects a member's ability to use a
+ # permission.
+ "role": "A String", # The role that this binding grants. For example,
+ # `roles/compute.serviceAgent`.
+ #
+ # For a complete list of predefined IAM roles, as well as the permissions in
+ # each role, see https://cloud.google.com/iam/help/roles/reference.
+ "rolePermission": "A String", # Indicates whether the role granted by this binding contains the specified
+ # permission.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition expression that prevents access unless the expression evaluates
+ # to `true`.
+ #
+ # To learn about IAM Conditions, see
+ # http://cloud.google.com/iam/help/conditions/overview.
+ # 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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "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.
+ },
+ "rolePermissionRelevance": "A String", # The relevance of the permission's existence, or nonexistence, in the role
+ # to the overall determination for the entire policy.
+ "memberships": { # Indicates whether each member in the binding includes the member specified
+ # in the request, either directly or indirectly. Each key identifies a member
+ # in the binding, and each value indicates whether the member in the binding
+ # includes the member in the request.
+ #
+ # For example, suppose that a binding includes the following members:
+ #
+ # * `user:alice@example.com`
+ # * `group:product-eng@example.com`
+ #
+ # You want to troubleshoot access for `user:bob@example.com`. This user is a
+ # member of the group `group:product-eng@example.com`.
+ #
+ # For the first member in the binding, the key is `user:alice@example.com`,
+ # and the `membership` field in the value is set to
+ # `MEMBERSHIP_NOT_INCLUDED`.
+ #
+ # For the second member in the binding, the key is
+ # `group:product-eng@example.com`, and the `membership` field in the value is
+ # set to `MEMBERSHIP_INCLUDED`.
+ "a_key": { # Details about whether the binding includes the member.
+ "relevance": "A String", # The relevance of the member's status to the overall determination for the
+ # binding.
+ "membership": "A String", # Indicates whether the binding includes the member.
+ },
+ },
+ "access": "A String", # Indicates whether _this binding_ provides the specified permission to the
+ # specified member for the specified resource.
+ #
+ # This field does _not_ indicate whether the member actually has the
+ # permission for the resource. There might be another binding that overrides
+ # this binding. To determine whether the member actually has the permission,
+ # use the `access` field in the
+ # TroubleshootIamPolicyResponse.
+ "relevance": "A String", # The relevance of this binding to the overall determination for the entire
+ # policy.
+ },
+ ],
"policy": { # An Identity and Access Management (IAM) policy, which specifies access # The IAM policy attached to the resource.
#
# If the sender of the request does not have access to the policy, this field
@@ -224,6 +323,123 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
+ "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.
+ { # Associates `members` with a `role`.
+ "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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "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.
+ },
+ "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",
+ ],
+ "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
@@ -300,9 +516,6 @@
# 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.
- "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.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
@@ -331,225 +544,12 @@
"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.
},
],
- "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`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "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.
- "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.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "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.
- },
- "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",
- ],
- },
- ],
- "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.
},
- "bindingExplanations": [ # Details about how each binding in the policy affects the member's ability,
- # or inability, to use the permission for the resource.
- #
- # If the sender of the request does not have access to the policy, this field
- # is omitted.
- { # Details about how a binding in a policy affects a member's ability to use a
- # permission.
- "memberships": { # Indicates whether each member in the binding includes the member specified
- # in the request, either directly or indirectly. Each key identifies a member
- # in the binding, and each value indicates whether the member in the binding
- # includes the member in the request.
- #
- # For example, suppose that a binding includes the following members:
- #
- # * `user:alice@example.com`
- # * `group:product-eng@example.com`
- #
- # You want to troubleshoot access for `user:bob@example.com`. This user is a
- # member of the group `group:product-eng@example.com`.
- #
- # For the first member in the binding, the key is `user:alice@example.com`,
- # and the `membership` field in the value is set to
- # `MEMBERSHIP_NOT_INCLUDED`.
- #
- # For the second member in the binding, the key is
- # `group:product-eng@example.com`, and the `membership` field in the value is
- # set to `MEMBERSHIP_INCLUDED`.
- "a_key": { # Details about whether the binding includes the member.
- "relevance": "A String", # The relevance of the member's status to the overall determination for the
- # binding.
- "membership": "A String", # Indicates whether the binding includes the member.
- },
- },
- "rolePermission": "A String", # Indicates whether the role granted by this binding contains the specified
- # permission.
- "relevance": "A String", # The relevance of this binding to the overall determination for the entire
- # policy.
- "role": "A String", # The role that this binding grants. For example,
- # `roles/compute.serviceAgent`.
- #
- # For a complete list of predefined IAM roles, as well as the permissions in
- # each role, see https://cloud.google.com/iam/help/roles/reference.
- "rolePermissionRelevance": "A String", # The relevance of the permission's existence, or nonexistence, in the role
- # to the overall determination for the entire policy.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # A condition expression that prevents access unless the expression evaluates
- # to `true`.
- #
- # To learn about IAM Conditions, see
- # http://cloud.google.com/iam/help/conditions/overview.
- # 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.
- "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.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "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.
- },
- "access": "A String", # Indicates whether _this binding_ provides the specified permission to the
- # specified member for the specified resource.
- #
- # This field does _not_ indicate whether the member actually has the
- # permission for the resource. There might be another binding that overrides
- # this binding. To determine whether the member actually has the permission,
- # use the `access` field in the
- # TroubleshootIamPolicyResponse.
- },
- ],
},
],
"access": "A String", # Indicates whether the member has the specified permission for the specified