REST Resource: projects.locations.ruleSets

{
  "name": string,
  "description": string,
  "source": string,
  "rules": [
    {
      object (Rule)
    }
  ]
}

string

The resource name of the rule set. Managed internally. Format: projects/{projectNumber}/locations/{location}/ruleSet/{rule_set_id}.

The name is ignored when creating a rule set.

string

Short description of the rule-set.

string

source of the rules i.e., customer name.

object (Rule)

List of rules given by the customer.

{
  "description": string,
  "ruleId": string,
  "triggerType": enum (TriggerType),
  "condition": string,
  "actions": [
    {
      object (Action)
    }
  ]
}

string

Short description of the rule and its context.

string

id of the rule. It has to be unique across all the examples. This is managed internally.

enum (TriggerType)

Identifies the trigger type for running the policy.

string

Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000

object (Action)

List of actions that are executed when the rule is satisfied.

{
  "actionId": string,

  // Union field action can be only one of the following:
  "accessControl": {
    object (AccessControlAction)
  },
  "dataValidation": {
    object (DataValidationAction)
  },
  "dataUpdate": {
    object (DataUpdateAction)
  },
  "addToFolder": {
    object (AddToFolderAction)
  },
  "publishToPubSub": {
    object (PublishAction)
  },
  "removeFromFolderAction": {
    object (RemoveFromFolderAction)
  },
  "deleteDocumentAction": {
    object (DeleteDocumentAction)
  }
  // End of list of possible types for union field action.
}

string

id of the action. Managed internally.

object (AccessControlAction)

Action triggering access control operations.

object (DataValidationAction)

Action triggering data validation operations.

object (DataUpdateAction)

Action triggering data update operations.

object (AddToFolderAction)

Action triggering create document link operation.

object (PublishAction)

Action publish to Pub/Sub operation.

object (RemoveFromFolderAction)

Action removing a document from a folder.

object (DeleteDocumentAction)

Action deleting the document.

{
  "operationType": enum (OperationType),
  "policy": {
    object (Policy)
  }
}

enum (OperationType)

Identifies the type of operation.

object (Policy)

Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.

{
  "version": integer,
  "bindings": [
    {
      object (Binding)
    }
  ],
  "auditConfigs": [
    {
      object (AuditConfig)
    }
  ],
  "etag": string
}

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.

object (Binding)

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.

object (AuditConfig)

Specifies cloud audit logging configuration for this policy.

string (bytes format)

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.

A base64-encoded string.

{
  "role": string,
  "members": [
    string
  ],
  "condition": {
    object (Expr)
  }
}

string

role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.

string

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. 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.

object (Expr)

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.

{
  "expression": string,
  "title": string,
  "description": string,
  "location": string
}

string

Textual representation of an expression in Common Expression language syntax.

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.

string

Optional. description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

{
  "service": string,
  "auditLogConfigs": [
    {
      object (AuditLogConfig)
    }
  ]
}

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.

object (AuditLogConfig)

The configuration for logging of each type of permission.

{
  "logType": enum (LogType),
  "exemptedMembers": [
    string
  ]
}

enum (LogType)

The log type that this config enables.

string

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

{
  "conditions": {
    string: string,
    ...
  }
}

map (key: string, value: string)

Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

{
  "entries": {
    string: string,
    ...
  }
}

map (key: string, value: string)

Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

{
  "folders": [
    string
  ]
}

string

Names of the folder under which new document is to be added. Format: projects/{projectNumber}/locations/{location}/documents/{documentId}.

{
  "topicId": string,
  "messages": [
    string
  ]
}

string

The topic id in the Pub/Sub service for which messages will be published to.

string

Messages to be published.

{
  "condition": string,
  "folder": string
}

string

Condition of the action to be executed.

string

name of the folder under which new document is to be added. Format: projects/{projectNumber}/locations/{location}/documents/{documentId}.

{
  "enableHardDelete": boolean
}

boolean

Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.