Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.consentStores.consents.reject
Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the specified Consent is in the REJECTED state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the ACTIVE or REVOKED state.
HTTP request
POST https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:reject
Required. The resource name of the Consent to reject, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consents/{consent_id}. 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.reject
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 documentation of the user's rejection of the draft 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
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-07-01 UTC."],[[["\u003cp\u003eThis API endpoint, \u003ccode\u003eprojects.locations.datasets.consentStores.consents.reject\u003c/code\u003e, is used to reject the latest revision of a specified Consent by updating its state to \u003ccode\u003eREJECTED\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eA new revision is not committed if the latest revision of the Consent is already in the \u003ccode\u003eREJECTED\u003c/code\u003e state, but an error will occur if it is in the \u003ccode\u003eACTIVE\u003c/code\u003e or \u003ccode\u003eREVOKED\u003c/code\u003e state.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses a \u003ccode\u003ePOST\u003c/code\u003e request to the specified URL, which includes parameters like \u003ccode\u003eprojects\u003c/code\u003e, \u003ccode\u003elocations\u003c/code\u003e, \u003ccode\u003edatasets\u003c/code\u003e, \u003ccode\u003econsentStores\u003c/code\u003e, and \u003ccode\u003econsents\u003c/code\u003e to identify the target consent.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can optionally include a \u003ccode\u003econsentArtifact\u003c/code\u003e which references the document of the user's rejection, and the proper IAM authorization is needed to access this artifact.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will return a \u003ccode\u003eConsent\u003c/code\u003e instance, and the API requires specific OAuth scopes for authentication and authorization.\u003c/p\u003e\n"]]],[],null,["# Method: consents.reject\n\n**Full name**: projects.locations.datasets.consentStores.consents.reject\n\nRejects the latest revision of the specified [Consent](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.consentStores.consents#Consent) by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the specified Consent is in the `REJECTED` state, no new revision is committed. A [FAILED_PRECONDITION](/healthcare-api/docs/reference/rest/Shared.Types/Code#ENUM_VALUES.FAILED_PRECONDITION) error occurs if the latest revision of the specified Consent is in the `ACTIVE` or `REVOKED` state.\n\n### HTTP request\n\n`POST https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:reject`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Consent](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.consentStores.consents#Consent).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-healthcare`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
