Policy Troubleshooter API MCP Server

# generated by fastapi-codegen: # filename: openapi.yaml # timestamp: 2025-06-29T02:37:48+00:00 from __future__ import annotations from enum import Enum from typing import Any, Dict, List, Optional from pydantic import BaseModel, Field class GoogleCloudPolicytroubleshooterV1AccessTuple(BaseModel): fullResourceName: Optional[str] = Field( None, description='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: Optional[str] = Field( None, description='Required. The IAM permission to check for the specified principal 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.', ) principal: Optional[str] = Field( None, description='Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.', ) class Access(Enum): ACCESS_STATE_UNSPECIFIED = 'ACCESS_STATE_UNSPECIFIED' GRANTED = 'GRANTED' NOT_GRANTED = 'NOT_GRANTED' UNKNOWN_CONDITIONAL = 'UNKNOWN_CONDITIONAL' UNKNOWN_INFO_DENIED = 'UNKNOWN_INFO_DENIED' class Relevance(Enum): HEURISTIC_RELEVANCE_UNSPECIFIED = 'HEURISTIC_RELEVANCE_UNSPECIFIED' NORMAL = 'NORMAL' HIGH = 'HIGH' class RolePermission(Enum): ROLE_PERMISSION_UNSPECIFIED = 'ROLE_PERMISSION_UNSPECIFIED' ROLE_PERMISSION_INCLUDED = 'ROLE_PERMISSION_INCLUDED' ROLE_PERMISSION_NOT_INCLUDED = 'ROLE_PERMISSION_NOT_INCLUDED' ROLE_PERMISSION_UNKNOWN_INFO_DENIED = 'ROLE_PERMISSION_UNKNOWN_INFO_DENIED' class RolePermissionRelevance(Enum): HEURISTIC_RELEVANCE_UNSPECIFIED = 'HEURISTIC_RELEVANCE_UNSPECIFIED' NORMAL = 'NORMAL' HIGH = 'HIGH' class Membership(Enum): MEMBERSHIP_UNSPECIFIED = 'MEMBERSHIP_UNSPECIFIED' MEMBERSHIP_INCLUDED = 'MEMBERSHIP_INCLUDED' MEMBERSHIP_NOT_INCLUDED = 'MEMBERSHIP_NOT_INCLUDED' MEMBERSHIP_UNKNOWN_INFO_DENIED = 'MEMBERSHIP_UNKNOWN_INFO_DENIED' MEMBERSHIP_UNKNOWN_UNSUPPORTED = 'MEMBERSHIP_UNKNOWN_UNSUPPORTED' class GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership(BaseModel): membership: Optional[Membership] = Field( None, description='Indicates whether the binding includes the principal.' ) relevance: Optional[Relevance] = Field( None, description="The relevance of the principal's status to the overall determination for the binding.", ) class GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest(BaseModel): accessTuple: Optional[GoogleCloudPolicytroubleshooterV1AccessTuple] = Field( None, description='The information to use for checking whether a principal has a permission for a resource.', ) class LogType(Enum): LOG_TYPE_UNSPECIFIED = 'LOG_TYPE_UNSPECIFIED' ADMIN_READ = 'ADMIN_READ' DATA_WRITE = 'DATA_WRITE' DATA_READ = 'DATA_READ' class GoogleIamV1AuditLogConfig(BaseModel): exemptedMembers: Optional[List[str]] = Field( None, description='Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.', ) logType: Optional[LogType] = Field( None, description='The log type that this config enables.' ) class GoogleRpcStatus(BaseModel): code: Optional[int] = Field( None, description='The status code, which should be an enum value of google.rpc.Code.', ) details: Optional[List[Dict[str, Any]]] = Field( None, description='A list of messages that carry the error details. There is a common set of message types for APIs to use.', ) message: Optional[str] = Field( None, description='A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.', ) class GoogleTypeExpr(BaseModel): description: Optional[str] = Field( None, description='Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.', ) expression: Optional[str] = Field( None, description='Textual representation of an expression in Common Expression Language syntax.', ) location: Optional[str] = Field( None, description='Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.', ) title: Optional[str] = Field( None, description='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.', ) class FieldXgafv(Enum): field_1 = '1' field_2 = '2' class Alt(Enum): json = 'json' media = 'media' proto = 'proto' class GoogleCloudPolicytroubleshooterV1BindingExplanation(BaseModel): access: Optional[Access] = Field( None, description='Required. Indicates whether _this binding_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another binding that overrides this binding. To determine whether the principal actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse.', ) condition: Optional[GoogleTypeExpr] = Field( None, description='A condition expression that prevents this binding from granting access unless the expression evaluates to `true`. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.', ) memberships: Optional[ Dict[ str, GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership ] ] = Field( None, description='Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request. For example, suppose that a binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` You want to troubleshoot access for `user:bob@example.com`. This user is a principal of the group `group:product-eng@example.com`. For the first principal 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 principal in the binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_INCLUDED`.', ) relevance: Optional[Relevance] = Field( None, description='The relevance of this binding to the overall determination for the entire policy.', ) role: Optional[str] = Field( None, description='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: Optional[RolePermission] = Field( None, description='Indicates whether the role granted by this binding contains the specified permission.', ) rolePermissionRelevance: Optional[RolePermissionRelevance] = Field( None, description="The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.", ) class GoogleIamV1AuditConfig(BaseModel): auditLogConfigs: Optional[List[GoogleIamV1AuditLogConfig]] = Field( None, description='The configuration for logging of each type of permission.' ) service: Optional[str] = Field( None, description='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.', ) class GoogleIamV1Binding(BaseModel): condition: Optional[GoogleTypeExpr] = Field( None, description='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 principals 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).', ) members: Optional[List[str]] = Field( None, description='Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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.', ) role: Optional[str] = Field( None, description='Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.', ) class GoogleIamV1Policy(BaseModel): auditConfigs: Optional[List[GoogleIamV1AuditConfig]] = Field( None, description='Specifies cloud audit logging configuration for this policy.' ) bindings: Optional[List[GoogleIamV1Binding]] = Field( None, description='Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.', ) etag: Optional[str] = Field( None, description='`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.', ) version: Optional[int] = Field( None, description='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).', ) class GoogleCloudPolicytroubleshooterV1ExplainedPolicy(BaseModel): access: Optional[Access] = Field( None, description='Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `access` field in the TroubleshootIamPolicyResponse.', ) bindingExplanations: Optional[ List[GoogleCloudPolicytroubleshooterV1BindingExplanation] ] = Field( None, description="Details about how each binding in the policy affects the principal'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.", ) fullResourceName: Optional[str] = Field( None, description='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.', ) policy: Optional[GoogleIamV1Policy] = Field( None, description='The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.', ) relevance: Optional[Relevance] = Field( None, description='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.', ) class GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse(BaseModel): access: Optional[Access] = Field( None, description='Indicates whether the principal has the specified permission for the specified resource, based on evaluating all of the applicable IAM policies.', ) errors: Optional[List[GoogleRpcStatus]] = Field( None, description='The general errors contained in the troubleshooting response.', ) explainedPolicies: Optional[ List[GoogleCloudPolicytroubleshooterV1ExplainedPolicy] ] = Field( None, description="List of IAM policies that were evaluated to check the principal'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.", )