Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1376177324.7 KB
projects

Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the REJECTED or REVOKED state.

patch/v1/{+name}

Path parameters

namestring required

Identifier. Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.

Query parameters

updateMaskstring

Required. The update mask to apply to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the user_id, policies, consent_artifact, and metadata fields can be updated.

Request body

revisionCreateTimestring google-datetime

Output only. The timestamp that the revision was created.

userIdstring

Required. User's UUID provided by the client.

consentArtifactstring

Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}.

expireTimestring google-datetime

Timestamp in UTC of when this Consent is considered expired.

namestring

Identifier. Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.

metadataobject

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.

revisionIdstring

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 @{revision_id} to the Consent's resource name.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'ARCHIVED' | 'REVOKED' | 'DRAFT' | 'REJECTED'

Required. Indicates the current state of this Consent.

ttlstring google-duration

Input only. The time to live for this Consent from when it is created.

Response

Successful response