Method: consents.patch

Full name: projects.locations.datasets.consentStores.consents.patch

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

HTTP request

PATCH https://healthcare.googleapis.com/v1/{consent.name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
consent.name

string

Resource name of the Consent, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consents/{consentId}. Cannot be changed after creation.

Query parameters

Parameters
updateMask

string(FieldMask format)

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 userId, policies, consentArtifact, and metadata fields can be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Consent.

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.