Method: consents.revoke

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 given consent is in the REVOKED state, no new revision is committed. A google.rpc.Code.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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the consent to revoke, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consents/{consentId}. An google.rpc.Code.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

The resource name of the consent artifact that contains proof of the end 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.

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.