Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.consentStores.consents.activate
Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. If the latest revision of the specified Consent is in the ACTIVE state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the REJECTED or REVOKED state.
HTTP request
POST https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:activate
Required. The resource name of the Consent to activate, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consents/{consentId}. An INVALID_ARGUMENT error occurs if revisionId is specified in the name.
Authorization requires the following IAM permission on the specified resource name:
healthcare.consents.activate
Request body
The request body contains data with the following structure:
JSON representation
{"consentArtifact": 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
consentArtifact
string
Required. The resource name of the Consent artifact that contains documentation of the user's consent, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consentArtifacts/{consent_artifact_id}. If the draft Consent had a Consent artifact, this Consent artifact overwrites it.
Authorization requires the following IAM permission on the specified resource consentArtifact:
healthcare.consentArtifacts.get
Union field expiration. Optional. Allows setting expiration time for Consents. Expired consents are ignored in access determination methods such as [CheckDataAccess]. This value overrides the expiration duration configured for the consent store. expiration can be only one of the following:
Timestamp in UTC of when this Consent is considered expired.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-21 UTC."],[[["This endpoint, `projects.locations.datasets.consentStores.consents.activate`, activates the latest revision of a specified Consent by creating a new revision with the `state` set to `ACTIVE`."],["Activating a Consent requires a `consentArtifact` resource name, which serves as documentation of the user's consent and can overwrite any existing artifact."],["The Consent activation process will fail if the latest revision is in `REJECTED` or `REVOKED` states, resulting in a `FAILED_PRECONDITION` error."],["You can set an expiration for the Consent either by specifying an exact `expireTime` or a `ttl` (time to live), which overrides any store configurations."],["The request requires appropriate IAM permissions, specifically `healthcare.consents.activate` and `healthcare.consentArtifacts.get`, along with one of two OAuth scopes: `https://www.googleapis.com/auth/cloud-healthcare` or `https://www.googleapis.com/auth/cloud-platform`."]]],[]]
