En esta página se explica cómo crear y gestionar almacenes de consentimientos.
La API Consent Management es una herramienta para registrar el consentimiento de los usuarios, gestionar las acciones en función de ese consentimiento y mantener la documentación y los registros asociados.
La organización que usa la API Consent Management es responsable de obtener y mantener los consentimientos necesarios para permitir el tratamiento de los datos a través de la API Consent Management.
La API Consent Management cumple el rol de punto de decisión de políticas. La aplicación o un proxy deben implementar el cumplimiento de las políticas. Para obtener más información, consulta Control de acceso basado en atributos.
Configurar permisos
Para usar las funciones de esta guía, debes tener el roles/healthcare.consentStoreAdmin
rol. Sin embargo, para realizar otras operaciones útiles con la API Consent Management, es posible que se necesiten permisos adicionales. Consulta más información en Control de acceso.
Crear un almacén de consentimientos
Los almacenes de consentimiento son los recursos de nivel superior que contienen toda la información relacionada con la configuración y el funcionamiento de la API Consent Management. Los almacenes de consentimientos pertenecen a un conjunto de datos de la API 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 tienda de consentimiento.
Consola
En la Google Cloud consola, ve a la página Conjuntos de datos.
Selecciona el conjunto de datos en el que quieras crear un almacén de consentimientos.
Haz clic en Crear almacén de datos.
Selecciona Consentimiento como tipo de almacén de datos.
En el campo ID, introduce el nombre que quieras, siempre que sea único en tu conjunto de datos. Si el nombre no es único, no se podrá crear la tienda.
Haz clic en Siguiente.
En Configurar almacén de consentimientos, seleccione una de las siguientes opciones para determinar cuándo caducan los consentimientos de su almacén:
- Sin plazo de vencimiento predeterminado significa que, de forma predeterminada, el consentimiento no caduca.
- Plazo de vencimiento predeterminado significa que, de forma predeterminada, los consentimientos vencen al cabo del número de días definido en el campo Plazo de vencimiento.
Para permitir que se creen nuevos recursos de consentimiento mediante
consentStores.patch
, haz clic en Permitir que se creen consentimientos con cada actualización.Haz clic en Siguiente.
Haz clic en Añadir etiqueta para definir etiquetas de clave y valor opcionales para organizar tusGoogle Cloud recursos.
Haz clic en Crear.
gcloud
Para crear un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores create
.
Antes de usar los datos de los comandos que se indican a continuación, haz los siguientes cambios:
- LOCATION: la ubicación del conjunto de datos
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- CONSENT_STORE_ID:
un identificador de la tienda de consentimiento. El ID del almacén de consentimiento debe cumplir los siguientes requisitos:
- Un ID único en su conjunto de datos
- Una cadena Unicode de entre 1 y 256 caracteres que incluya lo siguiente:
- Numbers
- Cartas
- Guiones bajos
- Guiones
- Periodos
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 siguiente:
Respuesta
Created consentStore [CONSENT_STORE_ID].
REST
Para crear un almacén de consentimiento, usa el método projects.locations.datasets.consentStores.create
.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- PROJECT_ID: el ID de tu Google Cloud proyecto
- LOCATION: la ubicación del conjunto de datos
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- CONSENT_STORE_ID:
un identificador de la tienda de consentimiento. El ID del almacén de consentimiento debe cumplir los siguientes requisitos:
- Un ID único en su conjunto de datos
- Una cadena Unicode de entre 1 y 256 caracteres que incluya lo siguiente:
- Numbers
- Cartas
- Guiones bajos
- Guiones
- Periodos
- DEFAULT_CONSENT_EXPIRATION_DURATION: tiempo predeterminado opcional, especificado en segundos, hasta que vencen los consentimientos creados en este almacén. La 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 parchear un recurso de consentimiento que no existe mediante
consentStores.patch
deben crear ese recurso. El valor predeterminado esFALSE
.
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 siguiente comando en el terminal para crear o sobrescribir este archivo en el directorio actual:
cat > request.json << 'EOF' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } EOF
A continuación, ejecuta el siguiente comando para enviar tu solicitud 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 siguiente comando en el terminal para crear o sobrescribir este archivo en el directorio actual:
@' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } '@ | Out-File -FilePath request.json -Encoding utf8
A continuación, ejecuta el siguiente comando para enviar tu solicitud 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 APIs
Copia el cuerpo de la solicitud y abre la página de referencia del método. El panel 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, rellena los campos obligatorios y haz clic en Ejecutar.
Deberías recibir una respuesta JSON similar a la siguiente:
Node.js
Python
Editar un almacén de consentimientos
Una vez que hayas creado un almacén de consentimiento, podrás actualizarlo. Por ejemplo, puede añadir o quitar etiquetas para organizar sus almacenes de consentimiento.
En los siguientes ejemplos se muestra cómo editar un almacén de consentimientos.
Consola
Para editar un almacén de consentimiento, sigue estos pasos:
- En la Google Cloud consola, ve a la página Conjuntos de datos.
- Seleccione el conjunto de datos que contenga el almacén de consentimiento que quiera editar.
- En la lista Almacenes de datos, haga clic en el que quiera editar.
- Para editar la configuración del almacén de consentimiento, haga clic en el icono de edición situado junto a Consent Store Configuration (Configuración del almacén de consentimiento).
Para obtener más información sobre las opciones de configuración del almacén de consentimiento, consulte el artículo Crear un almacén de consentimiento. - Para añadir una o varias etiquetas a la tienda, haga clic en Usar etiquetas de recursos. Etiquetas, Añadir etiqueta e introduzca la etiqueta clave-valor. Para obtener más información sobre las etiquetas de recursos, consulta el artículo
- Haz clic en Guardar.
gcloud
Para editar un almacén de consentimiento, ejecuta el comando gcloud healthcare consent-stores update
.
Antes de usar los datos de los comandos que se indican a continuación, haz los siguientes cambios:
- LOCATION: la ubicación del conjunto de datos
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- CONSENT_STORE_ID: el ID de la tienda de consentimiento
- KEY: la clave de un par clave-valor que se usa para organizar los almacenes de consentimiento. Consulte los requisitos y las limitaciones de las etiquetas en
labels
. - VALUE: el valor de un par clave-valor que se usa para organizar los almacenes de consentimiento. Consulte los requisitos y las limitaciones de las etiquetas en
labels
.
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 siguiente:
Respuesta
Updated consentStore [CONSENT_STORE_ID]. labels: KEY: VALUE name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Para editar un almacén de consentimientos, usa el método projects.locations.datasets.consentStores.patch
.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- PROJECT_ID: el ID de tu Google Cloud proyecto
- LOCATION: la ubicación del conjunto de datos
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- CONSENT_STORE_ID: el ID de la tienda de consentimiento
- KEY: la clave de un par clave-valor que se usa para organizar los almacenes de consentimiento. Consulte los requisitos y las limitaciones de las etiquetas en
labels
. - VALUE: el valor de un par clave-valor que se usa para organizar los almacenes de consentimiento. Consulte los requisitos y las limitaciones de las etiquetas en
labels
.
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 siguiente comando en el terminal para crear o sobrescribir este archivo en el directorio actual:
cat > request.json << 'EOF' { "labels": { "KEY": "VALUE" } } EOF
A continuación, ejecuta el siguiente comando para enviar tu solicitud 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 siguiente comando en el terminal para crear o sobrescribir este archivo en el directorio actual:
@' { "labels": { "KEY": "VALUE" } } '@ | Out-File -FilePath request.json -Encoding utf8
A continuación, ejecuta el siguiente comando para enviar tu solicitud 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 APIs
Copia el cuerpo de la solicitud y abre la página de referencia del método. El panel 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, rellena los campos obligatorios y haz clic en Ejecutar.
Deberías recibir una respuesta JSON similar a la siguiente:
Node.js
Python
Obtener detalles de un almacén de consentimientos
En los siguientes ejemplos se muestra cómo obtener detalles de un almacén de consentimientos.
Consola
Para ver los detalles de una tienda de consentimiento, sigue estos pasos:
- En la Google Cloud consola, ve a la página Conjuntos de datos.
- Selecciona el conjunto de datos que contiene el almacén de consentimiento que quieres ver.
- Haga clic en el nombre del almacén de consentimiento.
En la página Detalles del almacén de datos se muestran los detalles del almacén de consentimiento seleccionado.
gcloud
Para obtener información sobre un almacén de consentimiento, ejecuta el comando gcloud healthcare consent-stores describe
.
Antes de usar los datos de los comandos que se indican a continuación, haz los siguientes cambios:
- LOCATION: la ubicación del conjunto de datos
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- CONSENT_STORE_ID: el ID de la tienda de consentimiento
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
ConsentStore
, también aparecerá en la respuesta.
Respuesta
name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Para obtener detalles sobre un almacén de consentimiento, usa el método projects.locations.datasets.consentStores.get
.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- PROJECT_ID: el ID de tu Google Cloud proyecto
- LOCATION: la ubicación del conjunto de datos
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- CONSENT_STORE_ID: el ID de la tienda de consentimiento
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el comando siguiente:
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 comando siguiente:
$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 APIs
Abre la página de referencia del método. El panel Explorador de APIs se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Rellena los campos obligatorios y haz clic en Ejecutar.
ConsentStore
, también aparecerá en la respuesta.
Node.js
Python
Mostrar los almacenes de consentimientos de un conjunto de datos
En los siguientes ejemplos se muestra cómo enumerar los almacenes de consentimiento de un conjunto de datos.
Consola
Para ver los almacenes de datos de un conjunto de datos, sigue estos pasos:
- En la Google Cloud consola, ve a la página Conjuntos de datos.
- Selecciona el conjunto de datos que contiene el almacén de datos que quieres ver.
gcloud
Para enumerar los almacenes de consentimientos de un conjunto de datos, ejecuta el comando gcloud healthcare consent-stores list
.
Antes de usar los datos de los comandos que se indican a continuación, haz los siguientes cambios:
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- LOCATION: 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
ConsentStore
, también aparecerá en la respuesta.
ID LABELS LOCATION CONSENT_STORE_ID LOCATION
REST
Para enumerar los almacenes de consentimientos de un conjunto de datos, usa el método projects.locations.datasets.consentStores.list
.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- PROJECT_ID: el ID de tu Google Cloud proyecto
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- LOCATION: la ubicación del conjunto de datos
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el comando siguiente:
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 comando siguiente:
$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 APIs
Abre la página de referencia del método. El panel Explorador de APIs se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Rellena los campos obligatorios y haz clic en Ejecutar.
ConsentStore
, también aparecerá en la respuesta.
Node.js
Python
Eliminar un almacén de consentimientos
En los siguientes ejemplos se muestra cómo eliminar un almacén de consentimientos.
Consola
Para eliminar un almacén de datos, sigue estos pasos:
- En la Google Cloud consola, ve a la página Conjuntos de datos.
- Selecciona el conjunto de datos que contiene el almacén de datos que quieres eliminar.
- En la lista desplegable Acciones del almacén de datos que quiere eliminar, seleccione Eliminar.
- Para confirmar la acción, escribe el nombre del almacén de datos y haz clic en Eliminar.
gcloud
Para eliminar un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores delete
.
Antes de usar los datos de los comandos que se indican a continuación, haz los siguientes cambios:
- LOCATION: la ubicación del conjunto de datos
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- CONSENT_STORE_ID: el ID de la tienda de consentimiento
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
Deleted consentStore [CONSENT_STORE_ID].
REST
Para eliminar un almacén de consentimiento, usa el método projects.locations.datasets.consentStores.delete
.
Antes de usar los datos de la solicitud, haz las siguientes sustituciones:
- PROJECT_ID: el ID de tu Google Cloud proyecto
- LOCATION: la ubicación del conjunto de datos
- DATASET_ID: el conjunto de datos principal del almacén de consentimiento
- CONSENT_STORE_ID: el ID de la tienda de consentimiento
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el comando siguiente:
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 comando siguiente:
$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 APIs
Abre la página de referencia del método. El panel Explorador de APIs se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Rellena los campos obligatorios y haz clic en Ejecutar.
Deberías recibir una respuesta JSON similar a la siguiente:
Node.js
Python
Registros de auditoría
La API Consent Management escribe los siguientes tipos de registros de auditoría:
- Actividad de administración: registra las operaciones que modifican la configuración o los metadatos de un recurso. No puedes inhabilitar los registros de auditoría de actividad de administración.
- Acceso a los datos: contiene llamadas a la API que leen la configuración o los metadatos de los recursos, así como llamadas a APIs externas que crean, modifican o leen datos de recursos proporcionados por el cliente. Estos registros deben estar habilitados. Por ejemplo, los registros de auditoría de acceso a datos se pueden usar para registrar qué servicio ha realizado una solicitud de determinación de acceso, qué información se ha proporcionado en esa solicitud y cómo ha respondido la API a esa solicitud. Para obtener más información sobre los registros de auditoría de acceso a datos, consulta el artículo Configurar registros de auditoría de acceso a datos. Para obtener más información sobre el registro de auditoría en la API Cloud Healthcare, consulta Ver registros de auditoría de Cloud.
Para obtener más información sobre los registros de auditoría de la API Consent Management, consulta Ver registros de auditoría de Cloud.