blob: 8209cba6a06813c79f0d014a03e77acc73c11b04 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://policytroubleshooter.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Policy Troubleshooter",
"description": "",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/iam/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "policytroubleshooter:v1beta",
"kind": "discovery#restDescription",
"name": "policytroubleshooter",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"iam": {
"methods": {
"troubleshoot": {
"description": "Perform a check on whether a member is granted a permission\non a resource and how that grant/deny is determined accordinga\nto the resource's effective IAM policy interpretation.",
"flatPath": "v1beta/iam:troubleshoot",
"httpMethod": "POST",
"id": "policytroubleshooter.iam.troubleshoot",
"parameterOrder": [],
"parameters": {},
"path": "v1beta/iam:troubleshoot",
"request": {
"$ref": "GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyRequest"
},
"response": {
"$ref": "GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
"revision": "20191012",
"rootUrl": "https://policytroubleshooter.googleapis.com/",
"schemas": {
"GoogleCloudPolicytroubleshooterV1betaAccessTuple": {
"description": "AccessTuple defines information required for checking an access attempt.\nIn other words, this is the tuple given to `CheckAccess`.",
"id": "GoogleCloudPolicytroubleshooterV1betaAccessTuple",
"properties": {
"fullResourceName": {
"description": "Required. A full resource name according to\nhttps://cloud.google.com/apis/design/resource_names. This is the full\nresource name of the resource that access is checked against.",
"type": "string"
},
"permission": {
"description": "Required. The Cloud IAM permission under which defines the kind of access\nbeing explained. Example: \"resourcemanager.projects.get\" would explain\nif and why the principal has the resourcemanager.projects.get permission\non the resource specified in full_resource_name declared in this structure.\nSee https://cloud.google.com/iam/docs/testing-permissions",
"type": "string"
},
"principal": {
"description": "Required. The principal on behalf of who the access is explained for.\nThe format is one of the principal's email addresses associated with\nits gaia account. It must be an account that can appear as an actor.\nFor example groups are not supported. Currently, service accounts, users\nare supported.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudPolicytroubleshooterV1betaBindingExplanation": {
"description": "Binding Explanation.",
"id": "GoogleCloudPolicytroubleshooterV1betaBindingExplanation",
"properties": {
"access": {
"description": "REQUIRED: Access decision for this binding.",
"enum": [
"ACCESS_STATE_UNSPECIFIED",
"GRANTED",
"NOT_GRANTED",
"UNKNOWN_CONDITIONAL",
"UNKNOWN_INFO_DENIED"
],
"enumDescriptions": [
"Reserved",
"The access is granted due to one or multiple bindings found.",
"The access is not granted by the policy.",
"At least one binding was found but it is conditional. undecided,\nundetermined ,uncertain, open, tentative, contingent",
"Indicating that lack of access to the underlying information\ncauses the result to be undetermined.\nThis can be due to\n\n1) The caller has no access to the policy. In this case ExplainedPolicy\n will have not policy set.\n\n2) The caller has no access to some of the items referenced in the policy.\n In this case the policy in ExplainedPolicy will be set but the\n explanations field will contain at least one inconclusive element."
],
"type": "string"
},
"condition": {
"$ref": "GoogleTypeExpr",
"description": "The condition which needs to be satisfied in order for this\nbinding to grant the role to the principal.\nSee https://cloud.google.com/iam/docs/conditions-base"
},
"memberships": {
"additionalProperties": {
"$ref": "GoogleCloudPolicytroubleshooterV1betaBindingExplanationAnnotatedMembership"
},
"description": "For each member in the binding, provides information\nwhether or not the principal from the request is included\nin the member by which the CheckResult is keyed.\nMay indicate that the caller has no access to this information.\nexample key: 'group:cloud-iam-assist-eng@google.com'\nexample value '{NOT_GRANTED, HIGH}",
"type": "object"
},
"relevance": {
"description": "Bubbles up role_permission level relavance to BindingExplanation object.\nIf role permission is NORMAL, then binding relevance is NORMAL.\nIf role permission is HIGH, then binding relevance is HIGH.",
"enum": [
"HEURISTIC_RELEVANCE_UNSPECIFIED",
"NORMAL",
"HIGH"
],
"enumDescriptions": [
"Default value, presence of this should be error.",
"Fields annotated with this value contribute equally to evaluation\nresult. In other words the fields are NOT specially important. This is a\nsuperset of fields annotated as HIGH.",
"Fields annotated with this are more important than the fields\nannotated by NORMAL. They are used for annotating fields which on potential\nmodification can alter the overall access result."
],
"type": "string"
},
"role": {
"description": "The role that this binding grants in the policy.\nfor example \"roles/compute.serviceAgent\"",
"type": "string"
},
"rolePermission": {
"description": "Whether the role of this binding contains the checked permission",
"enum": [
"ROLE_PERMISSION_UNSPECIFIED",
"ROLE_PERMISSION_INCLUDED",
"ROLE_PERMISSION_NOT_INCLUDED",
"ROLE_PERMISSION_UNKNOWN_INFO_DENIED"
],
"enumDescriptions": [
"Reserved",
"Permission is included in the role.",
"Permission is included in the role.",
"Calling principal has no access to the role permission relation."
],
"type": "string"
},
"rolePermissionRelevance": {
"description": "The relevance of this permission with respect to the BindingExplanation.",
"enum": [
"HEURISTIC_RELEVANCE_UNSPECIFIED",
"NORMAL",
"HIGH"
],
"enumDescriptions": [
"Default value, presence of this should be error.",
"Fields annotated with this value contribute equally to evaluation\nresult. In other words the fields are NOT specially important. This is a\nsuperset of fields annotated as HIGH.",
"Fields annotated with this are more important than the fields\nannotated by NORMAL. They are used for annotating fields which on potential\nmodification can alter the overall access result."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudPolicytroubleshooterV1betaBindingExplanationAnnotatedMembership": {
"description": "Encapsulated membership and the relevance of that membership with respect\nto BindingExplanation.",
"id": "GoogleCloudPolicytroubleshooterV1betaBindingExplanationAnnotatedMembership",
"properties": {
"membership": {
"description": "Membership status.",
"enum": [
"MEMBERSHIP_UNSPECIFIED",
"MEMBERSHIP_INCLUDED",
"MEMBERSHIP_NOT_INCLUDED",
"MEMBERSHIP_UNKNOWN_INFO_DENIED",
"MEMBERSHIP_UNKNOWN_UNSUPPORTED"
],
"enumDescriptions": [
"Reserved.",
"Member is included in group/domain/allUsers or is a direct match.",
"Member is not included in group/domain/allUsers nor is a direct match.",
"Calling principal has no access to the membership relation.",
"This member type is currently not supported."
],
"type": "string"
},
"relevance": {
"description": "Relevance of this membership with respect to BindingExplanation.",
"enum": [
"HEURISTIC_RELEVANCE_UNSPECIFIED",
"NORMAL",
"HIGH"
],
"enumDescriptions": [
"Default value, presence of this should be error.",
"Fields annotated with this value contribute equally to evaluation\nresult. In other words the fields are NOT specially important. This is a\nsuperset of fields annotated as HIGH.",
"Fields annotated with this are more important than the fields\nannotated by NORMAL. They are used for annotating fields which on potential\nmodification can alter the overall access result."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudPolicytroubleshooterV1betaExplainedPolicy": {
"description": "An explained IAM policy combines the raw policy in the context\nof the resource which it is attached to along with detailed\nevaluation on the evaluation parameters provided through the request.",
"id": "GoogleCloudPolicytroubleshooterV1betaExplainedPolicy",
"properties": {
"access": {
"description": "Access decision for this section of the resource's effective policy.",
"enum": [
"ACCESS_STATE_UNSPECIFIED",
"GRANTED",
"NOT_GRANTED",
"UNKNOWN_CONDITIONAL",
"UNKNOWN_INFO_DENIED"
],
"enumDescriptions": [
"Reserved",
"The access is granted due to one or multiple bindings found.",
"The access is not granted by the policy.",
"At least one binding was found but it is conditional. undecided,\nundetermined ,uncertain, open, tentative, contingent",
"Indicating that lack of access to the underlying information\ncauses the result to be undetermined.\nThis can be due to\n\n1) The caller has no access to the policy. In this case ExplainedPolicy\n will have not policy set.\n\n2) The caller has no access to some of the items referenced in the policy.\n In this case the policy in ExplainedPolicy will be set but the\n explanations field will contain at least one inconclusive element."
],
"type": "string"
},
"bindingExplanations": {
"description": "Detailed binding evaluation explanations provide information\nabout how each binding contributes to the principal's\naccess or the lack thereof.",
"items": {
"$ref": "GoogleCloudPolicytroubleshooterV1betaBindingExplanation"
},
"type": "array"
},
"fullResourceName": {
"description": "Resource that this section of the effective policy attaches to.",
"type": "string"
},
"policy": {
"$ref": "GoogleIamV1Policy",
"description": "The IAM policy attached to the resource."
},
"relevance": {
"description": "Relevance of this Policy.",
"enum": [
"HEURISTIC_RELEVANCE_UNSPECIFIED",
"NORMAL",
"HIGH"
],
"enumDescriptions": [
"Default value, presence of this should be error.",
"Fields annotated with this value contribute equally to evaluation\nresult. In other words the fields are NOT specially important. This is a\nsuperset of fields annotated as HIGH.",
"Fields annotated with this are more important than the fields\nannotated by NORMAL. They are used for annotating fields which on potential\nmodification can alter the overall access result."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyRequest": {
"description": "TroubleshootIamPolicyRequest is used in TroubleshootIamPolicy",
"id": "GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyRequest",
"properties": {
"accessTuple": {
"$ref": "GoogleCloudPolicytroubleshooterV1betaAccessTuple",
"description": "Collection of attributes for example user, permission, resource that define\ntroubleshooter's input."
}
},
"type": "object"
},
"GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse": {
"description": "TroubleshootIamPolicyResponse is used in TroubleshootIamPolicy.",
"id": "GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse",
"properties": {
"access": {
"description": "Reflects whether the probed access was granted, denied\nor ultimately could not be decided from the caller's point of view.",
"enum": [
"ACCESS_STATE_UNSPECIFIED",
"GRANTED",
"NOT_GRANTED",
"UNKNOWN_CONDITIONAL",
"UNKNOWN_INFO_DENIED"
],
"enumDescriptions": [
"Reserved",
"The access is granted due to one or multiple bindings found.",
"The access is not granted by the policy.",
"At least one binding was found but it is conditional. undecided,\nundetermined ,uncertain, open, tentative, contingent",
"Indicating that lack of access to the underlying information\ncauses the result to be undetermined.\nThis can be due to\n\n1) The caller has no access to the policy. In this case ExplainedPolicy\n will have not policy set.\n\n2) The caller has no access to some of the items referenced in the policy.\n In this case the policy in ExplainedPolicy will be set but the\n explanations field will contain at least one inconclusive element."
],
"type": "string"
},
"explainedPolicies": {
"description": "List of explained policies.\nEach explanation corresponds to one policy along the ancestry path.",
"items": {
"$ref": "GoogleCloudPolicytroubleshooterV1betaExplainedPolicy"
},
"type": "array"
}
},
"type": "object"
},
"GoogleIamV1AuditConfig": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
"id": "GoogleIamV1AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "GoogleIamV1AuditLogConfig"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
"id": "GoogleIamV1AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1Binding": {
"description": "Associates `members` with a `role`.",
"id": "GoogleIamV1Binding",
"properties": {
"condition": {
"$ref": "GoogleTypeExpr",
"description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"GoogleIamV1Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions (defined by IAM or configured by users). A `binding` can\noptionally specify a `condition`, which is a logic expression that further\nconstrains the role binding based on attributes about the request and/or\ntarget resource.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time \u003c\n timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ]\n }\n\n**YAML Example**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"id": "GoogleIamV1Policy",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "GoogleIamV1AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally may specify a\n`condition` that determines when binding is in effect.\n`bindings` with no members will result in an error.",
"items": {
"$ref": "GoogleIamV1Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten. Due to blind-set semantics of an etag-less policy,\n'setIamPolicy' will not fail even if either of incoming or stored policy\ndoes not meet the version requirements.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nOperations affecting conditional bindings must specify version 3. This can\nbe either setting a conditional policy, modifying a conditional binding,\nor removing a conditional binding from the stored conditional policy.\nOperations on non-conditional policies may specify any valid value or\nleave the field unset.\n\nIf no etag is provided in the call to `setIamPolicy`, any version\ncompliance checks on the incoming and/or stored policy is skipped.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeExpr": {
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"id": "GoogleTypeExpr",
"properties": {
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
},
"location": {
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Policy Troubleshooter API",
"version": "v1beta",
"version_module": true
}