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/v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:revoke
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The resource name of the Consent to revoke, of the form Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "consentArtifact": string } |
Fields | |
---|---|
consentArtifact |
Optional. The resource name of the Consent artifact that contains proof of the user's revocation of the Consent, of the form Authorization requires the following IAM permission on the specified resource
|
Response body
If successful, the response body contains an instance of Consent
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-healthcare
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.