Method: consents.list

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

Lists the Consent in the given Consent store, returning each consent's latest revision.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the Consent store to retrieve consents from.

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

  • healthcare.consents.list

Query parameters

Parameters
pageSize

integer

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

pageToken

string

The nextPageToken value returned from the previous List request, if any.

filter

string

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

  • userId
  • consentArtifact
  • state
  • revisionCreateTime

Request body

The request body must be empty.

Response body

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

Lists the [Consents][google.cloud.healthcare.v1beta1.consent.Consents] in the given Consent store.

JSON representation
{
  "consents": [
    {
      object(Consent)
    }
  ],
  "nextPageToken": string
}
Fields
consents[]

object(Consent)

The returned consents. The maximum number of consents returned is determined by the value of pageSize in the ListConsentsRequest.

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.