Required. Name of the consent store where the requested dataId is stored, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}.
Authorization requires the following IAM permission on the specified resource consentStore:
healthcare.consentStores.checkDataAccess
Request body
The request body contains data with the following structure:
JSON representation
{"dataId": string,"requestAttributes": {string: string,...},"responseView": enum(ResponseView),// Union field consent_selection can be only one of the following:"consentList": {object(ConsentList)}// End of list of possible types for union field consent_selection.}
Fields
dataId
string
Required. The unique identifier of the resource to check access for. This identifier must correspond to a User data mapping in the given consent store.
requestAttributes
map (key: string, value: string)
The values of request attributes associated with this access request.
An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Optional. The view for CheckDataAccessResponse. If unspecified, defaults to BASIC and returns consented as TRUE or FALSE.
Union field consent_selection. The selection of Consents to evaluate the access request against. If no selection is specified, the access request is evaluated against all ACTIVE unexpired Consents with the same user_id as the data to check access for. consent_selection can be only one of the following:
Optional. Specific Consents to evaluate the access request against. These Consents must have the same userId as the evaluated User data mapping, must exist in the current consentStore, and have a state of either ACTIVE or DRAFT. A maximum of 100 Consents can be provided here. If no selection is specified, the access request is evaluated against all ACTIVE unexpired Consents with the same userId as the evaluated User data mapping.
All fields within CheckDataAccessResponse are populated. When set to FULL, all ACTIVE Consents are evaluated even if a matching policy is found during evaluation.
[[["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-23 UTC."],[[["\u003cp\u003eThis endpoint, \u003ccode\u003eprojects.locations.datasets.consentStores.checkDataAccess\u003c/code\u003e, verifies if a specific \u003ccode\u003edataId\u003c/code\u003e within a user data mapping in a given consent store is approved for a particular use.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a POST method to a URL defined using gRPC Transcoding syntax, requiring a consent store's path and the \u003ccode\u003ehealthcare.consentStores.checkDataAccess\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a \u003ccode\u003edataId\u003c/code\u003e, \u003ccode\u003erequestAttributes\u003c/code\u003e, and optionally a \u003ccode\u003eresponseView\u003c/code\u003e or a \u003ccode\u003econsentList\u003c/code\u003e for defining which consents to evaluate.\u003c/p\u003e\n"],["\u003cp\u003eThe response indicates whether the resource is consented (\u003ccode\u003econsented\u003c/code\u003e field) and includes details about the evaluated consents (\u003ccode\u003econsentDetails\u003c/code\u003e field), providing either a basic or full view of the response depending on \u003ccode\u003eresponseView\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAccess requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-healthcare\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: consentStores.checkDataAccess\n\n**Full name**: projects.locations.datasets.consentStores.checkDataAccess\n\nChecks if a particular dataId of a [User data mapping](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.consentStores.userDataMappings#UserDataMapping) in the specified [consent store](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.consentStores#ConsentStore) is consented for the specified use.\n\n### HTTP request\n\n`POST https://healthcare.googleapis.com/v1/{consentStore=projects/*/locations/*/datasets/*/consentStores/*}:checkDataAccess`\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\nChecks if a particular dataId of a [User data mapping](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.consentStores.userDataMappings#UserDataMapping) in the given [consent store](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.consentStores#ConsentStore) is consented for a given use.\n\nIf successful, the response body contains data with the following structure:\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).\n\nResponseView\n------------\n\nThe supported views for [CheckDataAccessResponse](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.consentStores/checkDataAccess#body.CheckDataAccessResponse)."]]
