@datafire/google_policytroubleshooter

Client library for Policy Troubleshooter API

Installation and Usage

npm install --save @datafire/google_policytroubleshooter

let google_policytroubleshooter = require('@datafire/google_policytroubleshooter').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_policytroubleshooter.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_policytroubleshooter.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

policytroubleshooter.iam.troubleshoot

Checks whether a member has a specific permission for a specific resource, and explains why the member does or does not have that permission.

google_policytroubleshooter.policytroubleshooter.iam.troubleshoot({}, context)

Input

• input object
  • body GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: 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.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse

Definitions

GoogleCloudPolicytroubleshooterV1AccessTuple

• GoogleCloudPolicytroubleshooterV1AccessTuple object: Information about the member, resource, and permission to check.
  • fullResourceName 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 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.
  • principal 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, [email protected] or [email protected]. The member must be a Google Account or a service account. Other types of members are not supported.

GoogleCloudPolicytroubleshooterV1BindingExplanation

• GoogleCloudPolicytroubleshooterV1BindingExplanation object: Details about how a binding in a policy affects a member's ability to use a permission.
  • access string (values: ACCESS_STATE_UNSPECIFIED, GRANTED, NOT_GRANTED, UNKNOWN_CONDITIONAL, UNKNOWN_INFO_DENIED): 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.
  • condition GoogleTypeExpr
  • memberships object: 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:[email protected] * group:[email protected] You want to troubleshoot access for user:[email protected]. This user is a member of the group group:[email protected]. For the first member in the binding, the key is user:[email protected], and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED. For the second member in the binding, the key is group:[email protected], and the membership field in the value is set to MEMBERSHIP_INCLUDED.
  • relevance string (values: HEURISTIC_RELEVANCE_UNSPECIFIED, NORMAL, HIGH): The relevance of this binding to the overall determination for the entire policy.
  • role 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 string (values: ROLE_PERMISSION_UNSPECIFIED, ROLE_PERMISSION_INCLUDED, ROLE_PERMISSION_NOT_INCLUDED, ROLE_PERMISSION_UNKNOWN_INFO_DENIED): Indicates whether the role granted by this binding contains the specified permission.
  • rolePermissionRelevance string (values: HEURISTIC_RELEVANCE_UNSPECIFIED, NORMAL, HIGH): The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.

GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership

• GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership object: Details about whether the binding includes the member.
  • membership string (values: MEMBERSHIP_UNSPECIFIED, MEMBERSHIP_INCLUDED, MEMBERSHIP_NOT_INCLUDED, MEMBERSHIP_UNKNOWN_INFO_DENIED, MEMBERSHIP_UNKNOWN_UNSUPPORTED): Indicates whether the binding includes the member.
  • relevance string (values: HEURISTIC_RELEVANCE_UNSPECIFIED, NORMAL, HIGH): The relevance of the member's status to the overall determination for the binding.

GoogleCloudPolicytroubleshooterV1ExplainedPolicy

• GoogleCloudPolicytroubleshooterV1ExplainedPolicy object: Details about how a specific IAM Policy contributed to the access check.
  • access string (values: ACCESS_STATE_UNSPECIFIED, GRANTED, NOT_GRANTED, UNKNOWN_CONDITIONAL, UNKNOWN_INFO_DENIED): 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.
  • bindingExplanations array: 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.
    • items GoogleCloudPolicytroubleshooterV1BindingExplanation
  • fullResourceName 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.
  • policy GoogleIamV1Policy
  • relevance string (values: HEURISTIC_RELEVANCE_UNSPECIFIED, NORMAL, HIGH): 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.

GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest

• GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest object: Request for TroubleshootIamPolicy.
  • accessTuple GoogleCloudPolicytroubleshooterV1AccessTuple

GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse

• GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse object: Response for TroubleshootIamPolicy.
  • access string (values: ACCESS_STATE_UNSPECIFIED, GRANTED, NOT_GRANTED, UNKNOWN_CONDITIONAL, UNKNOWN_INFO_DENIED): Indicates whether the member has the specified permission for the specified resource, based on evaluating all of the applicable IAM policies.
  • explainedPolicies array: 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.
    • items GoogleCloudPolicytroubleshooterV1ExplainedPolicy

GoogleIamV1AuditConfig

• GoogleIamV1AuditConfig object: 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:[email protected]" ] }, { "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:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.
  • auditLogConfigs array: The configuration for logging of each type of permission.
    • items GoogleIamV1AuditLogConfig
  • service 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.

GoogleIamV1AuditLogConfig

• GoogleIamV1AuditLogConfig object: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.
  • exemptedMembers array: Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
    • items string
  • logType string (values: LOG_TYPE_UNSPECIFIED, ADMIN_READ, DATA_WRITE, DATA_READ): The log type that this config enables.

GoogleIamV1Binding

• GoogleIamV1Binding object: Associates members with a role.
  • condition GoogleTypeExpr
  • members array: 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, [email protected] . * serviceAccount:{emailid}: An email address that represents a service account. For example, [email protected]. * group:{emailid}: An email address that represents a Google group. For example, [email protected]. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [email protected]?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, [email protected]?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, [email protected]?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.
    • items string
  • role string: Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

GoogleIamV1Policy

• GoogleIamV1Policy object: 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. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "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:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] 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.
  • auditConfigs array: Specifies cloud audit logging configuration for this policy.
    • items GoogleIamV1AuditConfig
  • bindings array: 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.
    • items GoogleIamV1Binding
  • etag 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.
  • version integer: 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.

GoogleTypeExpr

• GoogleTypeExpr object: 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.
  • description 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 string: Textual representation of an expression in Common Expression Language syntax.
  • location string: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
  • title 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.