REST Resource: projects.locations.datasets.consentStores.consentArtifacts

Resource: ConsentArtifact

Documentation of a user's consent.

JSON representation 
{
  "name": string,
  "userId": string,
  "userSignature": {
    object (Signature)
  },
  "guardianSignature": {
    object (Signature)
  },
  "witnessSignature": {
    object (Signature)
  },
  "consentContentScreenshots": [
    {
      object (Image)
    }
  ],
  "consentContentVersion": string,
  "metadata": {
    string: string,
    ...
  }
}
Fields
name

string

Identifier. Resource name of the Consent artifact, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
userId

string

Required. User's UUID provided by the client.
userSignature

object (Signature)

Optional. User's signature.
guardianSignature

object (Signature)

Optional. A signature from a guardian.
witnessSignature

object (Signature)

Optional. A signature from a witness.
consentContentScreenshots[]

object (Image)

Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
consentContentVersion

string

Optional. An string indicating the version of the consent information shown to the user.
metadata

map (key: string, value: string)

Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Signature

User signature.

JSON representation 
{
  "userId": string,
  "image": {
    object (Image)
  },
  "metadata": {
    string: string,
    ...
  },
  "signatureTime": string
}
Fields
userId

string

Required. User's UUID provided by the client.
image

object (Image)

Optional. An image of the user's signature.
metadata

map (key: string, value: string)

Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
signatureTime

string (Timestamp format)

Optional. Timestamp of the signature.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Image

Raw bytes representing consent artifact content.

JSON representation 
{

  // Union field data can be only one of the following:
  "rawBytes": string,
  "gcsUri": string
  // End of list of possible types for union field data.
}
Fields

Union field data.

data can be only one of the following:
rawBytes

string (bytes format)

Consent artifact content represented as a stream of bytes. This field is populated when returned in consentArtifacts.get response, but not included in consentArtifacts.create and ListConsentArtifact response.

A base64-encoded string.
gcsUri

string

Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{objectId}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in rawBytes.

Methods

create

 Creates a new Consent artifact in the parent consent store.

delete

 Deletes the specified Consent artifact.

get

 Gets the specified Consent artifact.

list

 Lists the Consent artifacts in the specified consent store.