Crear y administrar almacenes de consentimiento

En esta página, se muestra cómo crear y administrar almacenes de consentimientos.

La API de Consent Management es una herramienta para registrar los consentimientos de los usuarios, administrar las acciones basadas en esos consentimientos y mantener la documentación y los registros asociados.

La organización que usa la API de Consent Management es responsable de obtener y mantener los consentimientos necesarios para permitir el procesamiento de datos a través de la API de Consent Management.

La API de Consent Management cumple el rol de un punto de decisión de la política. La aplicación de la política debe implementarse en la aplicación o a través de un proxy. Para obtener más información, consulta Control de acceso basado en atributos.

Configura los permisos

Para usar las funciones de esta guía, debes tener el rol roles/healthcare.consentStoreAdmin. Sin embargo, para realizar operaciones adicionales útiles con la API de Consent Management, es posible que se necesiten permisos adicionales. Consulta Control de acceso para obtener más detalles.

Los almacenes de consentimientos son los recursos de nivel superior que contienen toda la información relacionada con la configuración y el funcionamiento de la API de Consent Management. Los almacenes de consentimientos pertenecen a un conjunto de datos de la API de Cloud Healthcare, que se asigna a una región cuando se crea. Esta región es la ubicación geográfica en la que opera tu almacén de consentimientos.

  1. En la consola de Google Cloud, ve a la página Conjuntos de datos.

    Ir a Conjuntos de datos

  2. Selecciona el conjunto de datos en el que deseas crear un almacén de consentimientos.

  3. Haz clic en Crear almacén de datos.

  4. Selecciona Consentir como el tipo de almacén de datos.

  5. En el campo ID, ingresa el nombre que desees, que sea único en tu conjunto de datos. Si el nombre no es único, la creación del almacén fallará.

  6. Haz clic en Siguiente.

  7. En Configura tu almacén de consentimientos, selecciona una de las siguientes opciones para determinar cuándo vencen los consentimientos de tu almacén:

    • No hay una hora de vencimiento predeterminada significa que, de forma predeterminada, los consentimientos no vencen.
    • Tiempo de vencimiento predeterminado significa que, de forma predeterminada, los consentimientos vencen después de la cantidad de días definida en el campo Hora de vencimiento.
  8. Para permitir que se creen recursos de consentimientos nuevos con consentStores.patch, haz clic en Permitir creación de consentimientos en la actualización.

  9. Haz clic en Siguiente.

  10. Haz clic en Agregar etiqueta para definir etiquetas de clave y valor opcionales a fin de organizar tus recursos de Google Cloud.

  11. Haz clic en Crear.

Para crear un almacén de consentimiento, ejecuta el comando gcloud healthcare consent-stores create.

Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:

  • LOCATION: Es la ubicación del conjunto de datos
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • CONSENT_STORE_ID: Es un identificador para el almacén de consentimientos. El ID del almacén de consentimientos debe tener lo siguiente:
    • Un ID único en su conjunto de datos
    • Una string de Unicode de 1 a 256 caracteres que consiste en lo siguiente:
      • Números
      • Letras
      • Guiones bajos
      • Guiones:
      • Puntos:

Ejecuta el siguiente comando:

Linux, macOS o Cloud Shell

gcloud healthcare consent-stores create CONSENT_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Windows (PowerShell)

gcloud healthcare consent-stores create CONSENT_STORE_ID `
  --dataset=DATASET_ID `
  --location=LOCATION

Windows (cmd.exe)

gcloud healthcare consent-stores create CONSENT_STORE_ID ^
  --dataset=DATASET_ID ^
  --location=LOCATION

Deberías recibir una respuesta similar a la que figura a continuación:

Respuesta

Created consentStore [CONSENT_STORE_ID].

Para crear un almacén de consentimiento, usa el método projects.locations.datasets.consentStores.create.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_IDEl ID de tu proyecto de Google Cloud.
  • LOCATION: Es la ubicación del conjunto de datos
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • CONSENT_STORE_ID: Es un identificador para el almacén de consentimientos. El ID del almacén de consentimientos debe tener lo siguiente:
    • Un ID único en su conjunto de datos
    • Una string de Unicode de 1 a 256 caracteres que consiste en lo siguiente:
      • Números
      • Letras
      • Guiones bajos
      • Guiones:
      • Puntos:
  • DEFAULT_CONSENT_EXPIRATION_DURATION: Es un tiempo predeterminado opcional, especificado en segundos, hasta que venzan los consentimientos creados en esta tienda. Esta duración debe ser de al menos 24 horas (86,400 segundos) y debe tener el formato DEFAULT_CONSENT_EXPIRATION_DURATIONs.
  • ENABLE_CONSENT_CREATE_ON_UPDATE: Un valor booleano opcional que determina si las solicitudes para aplicar un parche a un recurso de consentimientos inexistente con consentStores.patch deben crear ese recurso. El valor predeterminado es FALSE.

Cuerpo JSON de la solicitud:

{
  "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs",
  "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE"
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

cat > request.json << 'EOF'
{
  "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs",
  "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE"
}
EOF

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID"

PowerShell

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

@'
{
  "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs",
  "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID" | Select-Object -Expand Content

Explorador de API

Copia el cuerpo de la solicitud y abre la página de referencia del método. El panel del Explorador de APIs se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Pega el cuerpo de la solicitud en esta herramienta, completa cualquier otro campo obligatorio y haz clic en Ejecutar.

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const createConsentStore = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const consentStoreId = 'my-consent-store';
  const parent = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}`;
  const request = {parent, consentStoreId};

  await healthcare.projects.locations.datasets.consentStores.create(request);
  console.log(`Created consent store: ${consentStoreId}`);
};

createConsentStore();
def create_consent_store(
    project_id: str, location: str, dataset_id: str, consent_store_id: str
):
    """Creates a new consent store within the parent dataset.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    # consent_store_id = 'my-consent-store'  # replace with the consent store's ID
    consent_store_parent = (
        f"projects/{project_id}/locations/{location}/datasets/{dataset_id}"
    )

    request = (
        client.projects()
        .locations()
        .datasets()
        .consentStores()
        .create(parent=consent_store_parent, body={}, consentStoreId=consent_store_id)
    )

    response = request.execute()
    print(f"Created consent store: {consent_store_id}")
    return response

Después de crear un almacén de consentimiento, puedes actualizarlo. Por ejemplo, puedes agregar o quitar etiquetas para organizar los almacenes de consentimientos.

En los siguientes ejemplos, se muestra cómo editar un almacén de consentimientos.

Para editar un almacén de consentimientos, realiza los siguientes pasos:

  1. En la consola de Google Cloud, ve a la página Conjuntos de datos.

    Ir a Conjuntos de datos

  2. Selecciona el conjunto de datos que contenga el almacén de consentimientos que deseas editar.
  3. En la lista Almacenes de datos, haz clic en el almacén de datos que deseas editar.
  4. Para editar la configuración del almacén de consentimientos, haz clic en el ícono de edición junto a Configuración del almacén de consentimientos.

    Para obtener más información sobre las opciones de configuración del almacén de consentimientos, consulta Crea un almacén de consentimientos.
  5. Para agregar una o más etiquetas al almacén, haz clic en Etiquetas, luego, en Agregar etiqueta e ingresa la etiqueta de par clave-valor. Para obtener más información sobre las etiquetas de recursos, consulta Usa etiquetas de recursos.
  6. Haz clic en Guardar.

Para editar un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores update.

Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:

  • LOCATION: Es la ubicación del conjunto de datos
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • CONSENT_STORE_ID: El ID del almacén de consentimientos
  • KEY: Es la clave en un par clave-valor que se usa para organizar los almacenes de consentimientos. Consulta labels para conocer los requisitos y las limitaciones de las etiquetas.
  • VALUE: El valor en un par clave-valor que se usa para organizar los almacenes de consentimientos. Consulta labels para conocer los requisitos y las limitaciones de las etiquetas.

Ejecuta el siguiente comando:

Linux, macOS o Cloud Shell

gcloud healthcare consent-stores update CONSENT_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION \
  --update-labels=KEY=VALUE

Windows (PowerShell)

gcloud healthcare consent-stores update CONSENT_STORE_ID `
  --dataset=DATASET_ID `
  --location=LOCATION `
  --update-labels=KEY=VALUE

Windows (cmd.exe)

gcloud healthcare consent-stores update CONSENT_STORE_ID ^
  --dataset=DATASET_ID ^
  --location=LOCATION ^
  --update-labels=KEY=VALUE

Deberías recibir una respuesta similar a la que figura a continuación:

Respuesta

Updated consentStore [CONSENT_STORE_ID].
labels:
  KEY: VALUE
name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID

Para editar un almacén de consentimiento, usa el método projects.locations.datasets.consentStores.patch.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_IDEl ID de tu proyecto de Google Cloud.
  • LOCATION: Es la ubicación del conjunto de datos
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • CONSENT_STORE_ID: El ID del almacén de consentimientos
  • KEY: Es la clave en un par clave-valor que se usa para organizar los almacenes de consentimientos. Consulta labels para conocer los requisitos y las limitaciones de las etiquetas.
  • VALUE: El valor en un par clave-valor que se usa para organizar los almacenes de consentimientos. Consulta labels para conocer los requisitos y las limitaciones de las etiquetas.

Cuerpo JSON de la solicitud:

{
  "labels": {
    "KEY": "VALUE"
  }
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

cat > request.json << 'EOF'
{
  "labels": {
    "KEY": "VALUE"
  }
}
EOF

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels"

PowerShell

Guarda el cuerpo de la solicitud en un archivo llamado request.json. Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:

@'
{
  "labels": {
    "KEY": "VALUE"
  }
}
'@  | Out-File -FilePath request.json -Encoding utf8

Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels" | Select-Object -Expand Content

Explorador de API

Copia el cuerpo de la solicitud y abre la página de referencia del método. El panel del Explorador de APIs se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Pega el cuerpo de la solicitud en esta herramienta, completa cualquier otro campo obligatorio y haz clic en Ejecutar.

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const patchConsentStore = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const consentStoreId = 'my-consent-store';
  // const defaultConsentTtl = '172800s' Must be at least 24 hours, specified
  // in seconds, appended with 's' character.
  const name = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}/consentStores/${consentStoreId}`;
  const request = {
    name,
    updateMask: 'defaultConsentTtl',
    resource: {
      defaultConsentTtl: defaultConsentTtl,
    },
  };

  await healthcare.projects.locations.datasets.consentStores.patch(request);
  console.log(
    `Patched consent store ${consentStoreId} with default consent time-to-live ${defaultConsentTtl}`
  );
};

patchConsentStore();
def patch_consent_store(
    project_id: str,
    location: str,
    dataset_id: str,
    consent_store_id: str,
    default_consent_ttl,
):
    """Updates the consent store.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    # consent_store_id = 'my-consent-store'  # replace with the consent store's ID
    # default_consent_ttl = '172800s'  # replace with a default TTL
    consent_store_parent = "projects/{}/locations/{}/datasets/{}".format(
        project_id, location, dataset_id
    )
    consent_store_name = "{}/consentStores/{}".format(
        consent_store_parent, consent_store_id
    )

    # Updates the default time-to-live (TTL) of consents in the consent store.
    # Updating the TTL does not affect the expiration time of existing consents.
    # Specify as a duration in seconds with up to nine fractional digits,
    # terminated by "s", for example "172800s".
    # Minimum value is 24 hours, or "86400s" in seconds.
    patch = {"defaultConsentTtl": default_consent_ttl}

    request = (
        client.projects()
        .locations()
        .datasets()
        .consentStores()
        .patch(name=consent_store_name, updateMask="defaultConsentTtl", body=patch)
    )

    response = request.execute()
    print(
        "Patched consent store {} with new default consent TTL: {}".format(
            consent_store_id, default_consent_ttl
        )
    )

    return response

En los siguientes ejemplos, se muestra cómo obtener detalles sobre un almacén FHIR.

Para ver los detalles de un almacén de consentimiento, debes hacer lo siguiente:

  1. En la consola de Google Cloud, ve a la página Conjuntos de datos.

    Ir a Conjuntos de datos

  2. Selecciona el conjunto de datos que contenga el almacén de consentimientos que deseas ver.
  3. Haz clic en el nombre del almacén de consentimientos.

Para obtener más detalles sobre un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores describe.

Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:

  • LOCATION: Es la ubicación del conjunto de datos
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • CONSENT_STORE_ID: El ID del almacén de consentimientos

Ejecuta el siguiente comando:

Linux, macOS o Cloud Shell

gcloud healthcare consent-stores describe CONSENT_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Windows (PowerShell)

gcloud healthcare consent-stores describe CONSENT_STORE_ID `
  --dataset=DATASET_ID `
  --location=LOCATION

Windows (cmd.exe)

gcloud healthcare consent-stores describe CONSENT_STORE_ID ^
  --dataset=DATASET_ID ^
  --location=LOCATION
Si configuraste campos en el recurso ConsentStore, también aparecerán en la respuesta.

Respuesta

name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID

Para obtener más detalles sobre un almacén de consentimientos, usa el método projects.locations.datasets.consentStores.get.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_IDEl ID de tu proyecto de Google Cloud.
  • LOCATION: Es la ubicación del conjunto de datos
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • CONSENT_STORE_ID: El ID del almacén de consentimientos

Para enviar tu solicitud, elige una de estas opciones:

curl

Ejecuta el siguiente comando:

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"

PowerShell

Ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID" | Select-Object -Expand Content

Explorador de API

Abre la página de referencia del método. El panel del Explorador de API se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Completa los campos obligatorios y haz clic en Ejecutar.

Si configuraste algún campo en el recurso ConsentStore, también aparecerá en la respuesta.
const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const getConsentStore = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const consentStoreId = 'my-consent-store';
  const name = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}/consentStores/${consentStoreId}`;
  const request = {name};

  const consentStore =
    await healthcare.projects.locations.datasets.consentStores.get(request);
  console.log(consentStore.data);
};

getConsentStore();
def get_consent_store(
    project_id: str, location: str, dataset_id: str, consent_store_id: str
):
    """Gets the specified consent store.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    # Imports Python's built-in "json" module
    import json

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    # consent_store_id = 'my-consent-store'  # replace with the consent store's ID
    consent_store_parent = "projects/{}/locations/{}/datasets/{}".format(
        project_id, location, dataset_id
    )
    consent_store_name = "{}/consentStores/{}".format(
        consent_store_parent, consent_store_id
    )

    consent_stores = client.projects().locations().datasets().consentStores()
    consent_store = consent_stores.get(name=consent_store_name).execute()

    print(json.dumps(consent_store, indent=2))
    return consent_store

En los siguientes ejemplos, se muestra cómo enumerar los almacenes de consentimiento en un conjunto de datos.

Para ver los almacenes de datos en un conjunto de datos, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página Conjunto de datos.

    Ir a Conjuntos de datos

  2. Selecciona el conjunto de datos que contiene el almacén de datos que deseas ver.

Para mostrar una lista de los almacenes de consentimientos en un conjunto de datos, ejecuta el comando gcloud healthcare consent-stores list.

Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:

  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • LOCATION: Es la ubicación del conjunto de datos

Ejecuta el siguiente comando:

Linux, macOS o Cloud Shell

gcloud healthcare consent-stores list --dataset=DATASET_ID \
  --location=LOCATION

Windows (PowerShell)

gcloud healthcare consent-stores list --dataset=DATASET_ID `
  --location=LOCATION

Windows (cmd.exe)

gcloud healthcare consent-stores list --dataset=DATASET_ID ^
  --location=LOCATION
Si configuraste campos en el recurso ConsentStore, también aparecerán en la respuesta.
ID               LABELS  LOCATION
CONSENT_STORE_ID           LOCATION

Para mostrar una lista de los almacenes de consentimiento en un conjunto de datos, usa el método projects.locations.datasets.consentStores.list.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_IDEl ID de tu proyecto de Google Cloud.
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • LOCATION: Es la ubicación del conjunto de datos

Para enviar tu solicitud, elige una de estas opciones:

curl

Ejecuta el siguiente comando:

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores"

PowerShell

Ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores" | Select-Object -Expand Content

Explorador de API

Abre la página de referencia del método. El panel del Explorador de API se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Completa los campos obligatorios y haz clic en Ejecutar.

Si configuraste algún campo en el recurso ConsentStore, también aparecerá en la respuesta.
const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const listConsentStores = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  const parent = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}`;
  const request = {parent};

  const consentStores =
    await healthcare.projects.locations.datasets.consentStores.list(request);
  console.log(JSON.stringify(consentStores.data));
};

listConsentStores();
def list_consent_stores(project_id, location, dataset_id):
    """Lists the consent stores in the given dataset.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    consent_store_parent = "projects/{}/locations/{}/datasets/{}".format(
        project_id, location, dataset_id
    )

    consent_stores = (
        client.projects()
        .locations()
        .datasets()
        .consentStores()
        .list(parent=consent_store_parent)
        .execute()
        .get("consentStores", [])
    )

    for consent_store in consent_stores:
        print(consent_store)

    return consent_stores

En los siguientes ejemplos, se muestra cómo borrar un almacén de consentimiento.

Para borrar un almacén de datos, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página Conjuntos de datos.

    Ir a Conjuntos de datos

  2. Selecciona el conjunto de datos que contiene el almacén de datos que deseas borrar.
  3. Elige Borrar en la lista desplegable Acciones para el almacén de datos que deseas borrar.
  4. Para confirmar, escribe el nombre del almacén de datos y haz clic en Borrar.

Para borrar un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores delete.

Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:

  • LOCATION: Es la ubicación del conjunto de datos
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • CONSENT_STORE_ID: El ID del almacén de consentimientos

Ejecuta el siguiente comando:

Linux, macOS o Cloud Shell

gcloud healthcare consent-stores delete CONSENT_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Windows (PowerShell)

gcloud healthcare consent-stores delete CONSENT_STORE_ID `
  --dataset=DATASET_ID `
  --location=LOCATION

Windows (cmd.exe)

gcloud healthcare consent-stores delete CONSENT_STORE_ID ^
  --dataset=DATASET_ID ^
  --location=LOCATION
Para confirmar, escribe Y. Deberías recibir una respuesta similar a la que figura a continuación.
Deleted consentStore [CONSENT_STORE_ID].

Para borrar un almacén de consentimientos, usa el método projects.locations.datasets.consentStores.delete.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_IDEl ID de tu proyecto de Google Cloud.
  • LOCATION: Es la ubicación del conjunto de datos
  • DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
  • CONSENT_STORE_ID: El ID del almacén de consentimientos

Para enviar tu solicitud, elige una de estas opciones:

curl

Ejecuta el siguiente comando:

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"

PowerShell

Ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID" | Select-Object -Expand Content

Explorador de API

Abre la página de referencia del método. El panel del Explorador de API se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Completa los campos obligatorios y haz clic en Ejecutar.

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

const google = require('@googleapis/healthcare');
const healthcare = google.healthcare({
  version: 'v1',
  auth: new google.auth.GoogleAuth({
    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
  }),
});

const deleteConsentStore = async () => {
  // TODO(developer): uncomment these lines before running the sample
  // const cloudRegion = 'us-central1';
  // const projectId = 'adjective-noun-123';
  // const datasetId = 'my-dataset';
  // const consentStoreId = 'my-consent-store';
  const name = `projects/${projectId}/locations/${cloudRegion}/datasets/${datasetId}/consentStores/${consentStoreId}`;
  const request = {name};

  await healthcare.projects.locations.datasets.consentStores.delete(request);
  console.log(`Deleted consent store: ${consentStoreId}`);
};

deleteConsentStore();
def delete_consent_store(
    project_id: str, location: str, dataset_id: str, consent_store_id: str
):
    """Deletes the specified consent store.
    See https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/healthcare/api-client/v1/consent
    before running the sample."""
    # Imports the Google API Discovery Service.
    from googleapiclient import discovery

    api_version = "v1"
    service_name = "healthcare"
    # Returns an authorized API client by discovering the Healthcare API
    # and using GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = discovery.build(service_name, api_version)

    # TODO(developer): Uncomment these lines and replace with your values.
    # project_id = 'my-project'  # replace with your GCP project ID
    # location = 'us-central1'  # replace with the parent dataset's location
    # dataset_id = 'my-dataset'  # replace with the consent store's parent dataset ID
    # consent_store_id = 'my-consent-store'  # replace with the consent store's ID
    consent_store_parent = "projects/{}/locations/{}/datasets/{}".format(
        project_id, location, dataset_id
    )
    consent_store_name = "{}/consentStores/{}".format(
        consent_store_parent, consent_store_id
    )

    request = (
        client.projects()
        .locations()
        .datasets()
        .consentStores()
        .delete(name=consent_store_name)
    )

    response = request.execute()
    print(f"Deleted consent store: {consent_store_id}")
    return response

Registros de auditoría

La API de Consent Management escribe los siguientes tipos de registros de auditoría:

  • Actividad del administrador: Registra las operaciones que modifican la configuración o los metadatos de un recurso. No puedes inhabilitar los registros de auditoría de actividad del administrador.
  • Acceso a los datos: Contiene llamadas a la API que leen la configuración o los metadatos de los recursos, así como llamadas a la API externas que crean, modifican o leen datos de los recursos que proporciona el cliente. Estos registros deben estar habilitados. Por ejemplo, se pueden usar registros de auditoría de acceso a los datos para registrar qué servicio realizó una solicitud de determinación de acceso, qué información se proporcionó en esa solicitud y cómo la API respondió a esa solicitud. Para obtener más información sobre los registros de auditoría de acceso a los datos, consulta Configura registros de auditoría de acceso a los datos. Para obtener más información sobre el registro de auditoría en la API de Cloud Healthcare, visita Visualiza los Registros de auditoría de Cloud.

Para obtener más información sobre los registros de auditoría de la API de Consent Management, consulta Visualiza los registros de auditoría de Cloud.