Method: userDataMappings.list

Full name: projects.locations.datasets.consentStores.userDataMappings.list

Lists the User data mappings in the given Consent store.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/userDataMappings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the Consent store to retrieve user data mappings from.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.userDataMappings.list

Query parameters

Parameters
pageSize

integer

Limit on the number of user data mappings to return in a single response. If zero the default page size of 100 is used.

pageToken

string

Token to retrieve the next page of results or empty to get the first page.

filter

string

Restricts the user data mappings returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings The fields available for filtering are:

  • dataId
  • userId
  • archived
  • archiveTime

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Lists the [User data mappings] [google.cloud.healthcare.v1beta1.consent.UserDataMappings] in the given Consent store.

JSON representation
{
  "userDataMappings": [
    {
      object(UserDataMapping)
    }
  ],
  "nextPageToken": string
}
Fields
userDataMappings[]

object(UserDataMapping)

The returned user data mappings. The maximum number of user data mappings returned is determined by the value of pageSize in the ListUserDataMappingsRequest.

nextPageToken

string

Token to retrieve the next page of results or empty if there are no more results in the list.

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.