Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.consentStores.consents.revoke
Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED. If the latest revision of the specified Consent is in the REVOKED state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in DRAFT or REJECTED state.
HTTP request
POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:revoke
Required. The resource name of the Consent to revoke, 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.revoke
Request body
The request body contains data with the following structure:
JSON representation
{"consentArtifact": string}
Fields
consentArtifact
string
Optional. The resource name of the Consent artifact that contains proof of the user's revocation of the Consent, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consentArtifacts/{consent_artifact_id}.
Authorization requires the following IAM permission on the specified resource consentArtifact:
healthcare.consentArtifacts.get
Response body
If successful, the response body contains an instance of Consent.
[[["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-01-28 UTC."],[[["This API endpoint, `projects.locations.datasets.consentStores.consents.revoke`, is used to revoke the latest revision of a specified Consent by creating a new revision with the state set to `REVOKED`."],["A `FAILED_PRECONDITION` error will occur if the latest revision of the consent is in `DRAFT` or `REJECTED` state."],["The HTTP request is a `POST` method that follows a specific URL pattern: `https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:revoke`, and requires the `healthcare.consents.revoke` IAM permission."],["The request body optionally includes a `consentArtifact` field, which is the resource name of the consent artifact containing proof of revocation, and requires the `healthcare.consentArtifacts.get` IAM permission."],["A successful response will contain an instance of the updated `Consent`, and the request requires one of the following OAuth scopes: `https://www.googleapis.com/auth/cloud-healthcare` or `https://www.googleapis.com/auth/cloud-platform`."]]],[]]
