docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/policytroubleshooter_v1.iam.html b/docs/dyn/policytroubleshooter_v1.iam.html
new file mode 100644
index 0000000..0fad765
--- /dev/null
+++ b/docs/dyn/policytroubleshooter_v1.iam.html
@@ -0,0 +1,560 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="policytroubleshooter_v1.html">Policy Troubleshooter API</a> . <a href="policytroubleshooter_v1.iam.html">iam</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#troubleshoot">troubleshoot(body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Checks whether a member has a specific permission for a specific resource,</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="troubleshoot">troubleshoot(body=None, x__xgafv=None)</code>
+ <pre>Checks whether a member has a specific permission for a specific resource,
+and explains why the member does or does not have that permission.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{ # 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.
+ "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
+ # `my-service-account@my-project.iam.gserviceaccount.com`.
+ #
+ # The member must be a Google Account or a service account. Other types of
+ # members are not supported.
+ "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.
+ "permission": "A String", # Required. The IAM permission to check for the specified member and resource.
+ #
+ # For a complete list of IAM permissions, see
+ # https://cloud.google.com/iam/help/permissions/reference.
+ #
+ # For a complete list of predefined IAM roles and the permissions in each
+ # role, see https://cloud.google.com/iam/help/roles/reference.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for TroubleshootIamPolicy.
+ "access": "A String", # Indicates whether the member has the specified permission for the specified
+ # resource, based on evaluating all of the applicable IAM policies.
+ "explainedPolicies": [ # List of IAM policies that were evaluated to check the member's permissions,
+ # with annotations to indicate how each policy contributed to the final
+ # result.
+ #
+ # The list of policies can include the policy for the resource itself. It can
+ # also include policies that are inherited from higher levels of the resource
+ # hierarchy, including the organization, the folder, and the project.
+ #
+ # To learn more about the resource hierarchy, see
+ # https://cloud.google.com/iam/help/resource-hierarchy.
+ { # Details about how a specific IAM Policy contributed
+ # to the access check.
+ "access": "A String", # Indicates whether _this policy_ 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 policy that overrides
+ # this policy. To determine whether the member actually has the permission,
+ # use the `access` field in the
+ # TroubleshootIamPolicyResponse.
+ "relevance": "A String", # The relevance of this policy to the overall determination in the
+ # TroubleshootIamPolicyResponse.
+ #
+ # If the sender of the request does not have access to the policy, this field
+ # is omitted.
+ "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.
+ },
+ },
+ "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.
+ "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.
+ "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.
+ "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.
+ },
+ "rolePermissionRelevance": "A String", # The relevance of the permission's existence, or nonexistence, in the role
+ # to the overall determination for the entire policy.
+ "access": "A String", # Required. 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.
+ },
+ ],
+ "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
+ # is empty.
+ # 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/).
+ "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.
+ "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).
+ "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.
+ "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.
+ "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.
+ },
+ "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",
+ ],
+ },
+ ],
+ },
+ "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.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file