REST Resource: projects.locations.datasets.consentStores.consents

Resource: Consent

Represents a user's consent.

JSON representation
{ "name": string, "revisionId": string, "revisionCreateTime": string, "userId": string, "policies": [ { object(Policy) } ], "consentArtifact": string, "state": enum(State), "metadata": { string: string, ... }, // Union field expiration can be only one of the following: "expireTime": string, "ttl": string // End of list of possible types for union field expiration. }

Fields
name	string Resource name of the Consent, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consents/{consentId}. Cannot be changed after creation.
revisionId	string Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending @{revisionId} to the Consent's resource name.
revisionCreateTime	string(Timestamp format) Output only. The timestamp that the revision was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
userId	string Required. User's UUID provided by the client.
policies[]	object(Policy) Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
consentArtifact	string Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consentArtifacts/{consent_artifact_id}.
state	enum(State) Required. Indicates the current state of this Consent.
metadata	map (key: string, value: string) Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: be between 1 and 63 characters long have a UTF-8 encoding of maximum 128 bytes begin with a letter consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Union field expiration. Optional. Allows setting expiration time for Consents. Expired Consents are ignored in access determination methods such as [CheckDataAccess]. This value replaces any default expiration duration configured for the Consent store. expiration can be only one of the following:
expireTime	string(Timestamp format) Timestamp in UTC of when this Consent is considered expired. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
ttl	string(Duration format) Input only. The time to live for this Consent from when it is created. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

Policy

Represents a user's consent in terms of the resources that can be accessed and under what conditions.

JSON representation
{ "resourceAttributes": [ { object(Attribute) } ], "authorizationRule": { object(Expr) } }

Fields
resourceAttributes[]	object(Attribute) The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user.
authorizationRule	object(Expr) Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have IN operator as well as at most 10 logical operators that are limited to AND(&&), OR(||).

Expr

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.

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

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

State

The state of the Consent resource.

Enums
STATE_UNSPECIFIED	No state specified. Treated as ACTIVE only at the time of resource creation.
ACTIVE	The Consent is active and is considered when evaluating a user's consent on resources.
ARCHIVED	The archived state is currently not being used.
REVOKED	A revoked Consent is not considered when evaluating a user's consent on resources.
DRAFT	A draft Consent is not considered when evaluating a user's consent on resources unless explicitly specified.
REJECTED	When a draft Consent is rejected by a user, it is set to a rejected state. A rejected Consent is not considered when evaluating a user's consent on resources.

Methods
activate	Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE.
create	Creates a new Consent in the parent consent store.
delete	Deletes the Consent and its revisions.
deleteRevision	Deletes the specified revision of a Consent.
get	Gets the specified revision of a Consent, or the latest revision if revision_id is not specified in the resource name.
list	Lists the Consent in the given consent store, returning each Consent's latest revision.
listRevisions	Lists the revisions of the specified Consent in reverse chronological order.
patch	Updates the latest revision of the specified Consent by committing a new revision with the changes.
reject	Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED.
revoke	Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED.