Questa pagina mostra come creare e gestire gli archivi di consensi.
L'API Consent Management è uno strumento per registrare i consensi degli utenti, gestire le azioni in base a questi consensi e mantenere la documentazione e i record associati.
L'organizzazione che utilizza l'API Consent Management è responsabile dell'ottenimento e del mantenimento dei consensi necessari per consentire il trattamento di qualsiasi dato tramite l'API Consent Management.
L'API Consent Management svolge il ruolo di punto decisionale delle norme. L'applicazione delle norme deve essere implementata nell'applicazione o tramite un proxy. Per ulteriori informazioni, consulta Controllo dell'accesso basato su attributi.
Configurare le autorizzazioni
Per utilizzare le funzionalità descritte in questa guida, devi avere il
roles/healthcare.consentStoreAdmin
ruolo. Tuttavia, per eseguire operazioni utili aggiuntive con l'API di gestione del consenso, potrebbero essere necessarie autorizzazioni aggiuntive. Per maggiori dettagli, consulta Controllo dell'accesso.
Creazione di un archivio di consensi
I negozi di consenso sono le risorse di primo livello che contengono tutte le informazioni relative alla configurazione e al funzionamento dell'API Consent Management. Gli archivi del consenso appartengono a un set di dati dell'API Cloud Healthcare, che viene assegnato a una regione al momento della creazione. Questa regione è la posizione geografica in cui opera il tuo archivio del consenso.
Console
Nella console Google Cloud , vai alla pagina Set di dati.
Seleziona il set di dati in cui vuoi creare un archivio del consenso.
Fai clic su Crea datastore.
Seleziona Consenso come tipo di datastore.
Nel campo ID, inserisci un nome a tua scelta univoco nel tuo set di dati. Se il nome non è univoco, la creazione dello store non riesce.
Fai clic su Avanti.
In Configura il tuo datastore di consensi, seleziona una delle seguenti opzioni per determinare la scadenza dei consensi nel tuo datastore:
- Nessuna scadenza predefinita significa che, per impostazione predefinita, i consensi non scadono.
- Scadenza predefinita significa che, per impostazione predefinita, i consensi scadono dopo il numero di giorni definito nel campo Scadenza.
Per consentire la creazione di nuove risorse consenso utilizzando
consentStores.patch
, fai clic su Permetti la creazione di consensi durante l'aggiornamento.Fai clic su Avanti.
Fai clic su Aggiungi etichetta per definire le etichette chiave e valore facoltative per organizzare le risorseGoogle Cloud .
Fai clic su Crea.
gcloud
Per creare un archivio di consensi, esegui il comando gcloud healthcare consent-stores create
.
Prima di utilizzare i dati dei comandi riportati di seguito, effettua le seguenti sostituzioni:
- LOCATION: la posizione del set di dati
- DATASET_ID: il set di dati principale dell'archivio del consenso
- CONSENT_STORE_ID:
un identificatore per l'archivio del consenso. L'ID del negozio di consenso deve avere quanto segue:
- Un ID univoco nel suo set di dati
- Una stringa Unicode di 1-256 caratteri composta da:
- Numeri
- Lettere
- Trattini bassi
- Trattini
- Punti
Esegui questo 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
Dovresti ricevere una risposta simile alla seguente:
Risposta
Created consentStore [CONSENT_STORE_ID].
REST
Per creare un archivio del consenso, utilizza il metodo projects.locations.datasets.consentStores.create
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: l'ID del tuo Google Cloud progetto
- LOCATION: la posizione del set di dati
- DATASET_ID: il set di dati principale dell'archivio del consenso
- CONSENT_STORE_ID:
un identificatore per l'archivio del consenso. L'ID del negozio di consenso deve avere quanto segue:
- Un ID univoco nel suo set di dati
- Una stringa Unicode di 1-256 caratteri composta da:
- Numeri
- Lettere
- Trattini bassi
- Trattini
- Punti
- DEFAULT_CONSENT_EXPIRATION_DURATION: un tempo predefinito facoltativo, specificato in secondi, fino alla scadenza dei consensi creati in questo archivio. Questa durata deve essere di almeno 24 ore (86.400 secondi) e deve essere nel formato
DEFAULT_CONSENT_EXPIRATION_DURATIONs
. - ENABLE_CONSENT_CREATE_ON_UPDATE: un valore booleano facoltativo che determina se le richieste di applicazione di patch a una risorsa di consenso inesistente utilizzando
consentStores.patch
devono creare la risorsa. Il valore predefinito èFALSE
.
Corpo JSON della richiesta:
{ "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" }
Per inviare la richiesta, scegli una di queste opzioni:
curl
Salva il corpo della richiesta in un file denominato request.json
.
Esegui questo comando nel terminale per creare o sovrascrivere
questo file nella directory corrente:
cat > request.json << 'EOF' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } EOF
Quindi, esegui questo comando per inviare la richiesta 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
Salva il corpo della richiesta in un file denominato request.json
.
Esegui questo comando nel terminale per creare o sovrascrivere
questo file nella directory corrente:
@' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } '@ | Out-File -FilePath request.json -Encoding utf8
Quindi, esegui questo comando per inviare la richiesta 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
Explorer API
Copia il corpo della richiesta e apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Explorer API. Puoi interagire con questo strumento per inviare richieste. Incolla il corpo della richiesta in questo strumento, compila gli altri campi obbligatori e fai clic su Esegui.
Dovresti ricevere una risposta JSON simile alla seguente:
Node.js
Python
Modificare un archivio di consensi
Dopo aver creato un archivio del consenso, puoi aggiornarlo. Ad esempio, puoi aggiungere o rimuovere etichette per organizzare i tuoi negozi di consenso.
Gli esempi riportati di seguito mostrano come modificare un archivio del consenso.
Console
Per modificare un archivio del consenso:
- Nella console Google Cloud , vai alla pagina Set di dati.
- Seleziona il set di dati contenente l'archivio del consenso che vuoi modificare.
- Nell'elenco Datastore, fai clic sul datastore da modificare.
- Per modificare la configurazione dell'archivio del consenso, fai clic sull'icona di modifica accanto a Configurazione archivio del consenso.
Per ulteriori informazioni sulle opzioni di configurazione dell'archivio del consenso, vedi Creare un archivio del consenso. - Per aggiungere una o più etichette allo store, fai clic su Utilizzare le etichette delle risorse. Etichette, fai clic su Aggiungi etichetta e inserisci l'etichetta chiave/valore. Per saperne di più sulle etichette delle risorse, vedi
- Fai clic su Salva.
gcloud
Per modificare un archivio del consenso, esegui il comando gcloud healthcare consent-stores update
.
Prima di utilizzare i dati dei comandi riportati di seguito, effettua le seguenti sostituzioni:
- LOCATION: la posizione del set di dati
- DATASET_ID: il set di dati principale dell'archivio del consenso
- CONSENT_STORE_ID: l'ID dell'archivio del consenso
- KEY: la chiave di una coppia chiave-valore utilizzata per organizzare gli archivi del consenso. Consulta
labels
per i requisiti e le limitazioni delle etichette. - VALUE: il valore di una coppia chiave-valore utilizzata per organizzare gli archivi del consenso. Consulta
labels
per i requisiti e le limitazioni delle etichette.
Esegui questo 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
Dovresti ricevere una risposta simile alla seguente:
Risposta
Updated consentStore [CONSENT_STORE_ID]. labels: KEY: VALUE name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Per modificare un archivio del consenso, utilizza il metodo projects.locations.datasets.consentStores.patch
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: l'ID del tuo Google Cloud progetto
- LOCATION: la posizione del set di dati
- DATASET_ID: il set di dati principale dell'archivio del consenso
- CONSENT_STORE_ID: l'ID dell'archivio del consenso
- KEY: la chiave di una coppia chiave-valore utilizzata per organizzare gli archivi del consenso. Consulta
labels
per i requisiti e le limitazioni delle etichette. - VALUE: il valore di una coppia chiave-valore utilizzata per organizzare gli archivi del consenso. Consulta
labels
per i requisiti e le limitazioni delle etichette.
Corpo JSON della richiesta:
{ "labels": { "KEY": "VALUE" } }
Per inviare la richiesta, scegli una di queste opzioni:
curl
Salva il corpo della richiesta in un file denominato request.json
.
Esegui questo comando nel terminale per creare o sovrascrivere
questo file nella directory corrente:
cat > request.json << 'EOF' { "labels": { "KEY": "VALUE" } } EOF
Quindi, esegui questo comando per inviare la richiesta 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
Salva il corpo della richiesta in un file denominato request.json
.
Esegui questo comando nel terminale per creare o sovrascrivere
questo file nella directory corrente:
@' { "labels": { "KEY": "VALUE" } } '@ | Out-File -FilePath request.json -Encoding utf8
Quindi, esegui questo comando per inviare la richiesta 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
Explorer API
Copia il corpo della richiesta e apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Explorer API. Puoi interagire con questo strumento per inviare richieste. Incolla il corpo della richiesta in questo strumento, compila gli altri campi obbligatori e fai clic su Esegui.
Dovresti ricevere una risposta JSON simile alla seguente:
Node.js
Python
Recupero dei dettagli di un archivio di consensi
Gli esempi riportati di seguito mostrano come recuperare i dettagli di un archivio dei consensi.
Console
Per visualizzare i dettagli di un archivio del consenso:
- Nella console Google Cloud , vai alla pagina Set di dati.
- Seleziona il set di dati contenente l'archivio del consenso che vuoi visualizzare.
- Fai clic sul nome dell'archivio del consenso.
La pagina Dettagli datastore mostra i dettagli dell'archivio del consenso selezionato.
gcloud
Per visualizzare i dettagli di un archivio del consenso, esegui il comando gcloud healthcare consent-stores describe
.
Prima di utilizzare i dati dei comandi riportati di seguito, effettua le seguenti sostituzioni:
- LOCATION: la posizione del set di dati
- DATASET_ID: il set di dati principale dell'archivio del consenso
- CONSENT_STORE_ID: l'ID dell'archivio del consenso
Esegui questo 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
hai configurato dei campi, questi vengono visualizzati anche nella risposta.
Risposta
name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Per visualizzare i dettagli di un archivio del consenso, utilizza il metodo projects.locations.datasets.consentStores.get
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: l'ID del tuo Google Cloud progetto
- LOCATION: la posizione del set di dati
- DATASET_ID: il set di dati principale dell'archivio del consenso
- CONSENT_STORE_ID: l'ID dell'archivio del consenso
Per inviare la richiesta, scegli una di queste opzioni:
curl
Esegui questo 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
Esegui questo 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
Explorer API
Apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Explorer API. Puoi interagire con questo strumento per inviare richieste. Completa i campi obbligatori e fai clic su Esegui.
ConsentStore
hai configurato dei campi, questi vengono visualizzati anche nella risposta.
Node.js
Python
Elenco degli archivi di consensi in un set di dati
Gli esempi riportati di seguito mostrano come elencare gli archivi del consenso in un set di dati.
Console
Per visualizzare i datastore in un set di dati:
- Nella console Google Cloud , vai alla pagina Set di dati.
- Seleziona il set di dati contenente il datastore che vuoi visualizzare.
gcloud
Per elencare gli archivi di consensi in un set di dati, esegui il comando gcloud healthcare consent-stores list
.
Prima di utilizzare i dati dei comandi riportati di seguito, effettua le seguenti sostituzioni:
- DATASET_ID: il set di dati principale dell'archivio del consenso
- LOCATION: la posizione del set di dati
Esegui questo 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
hai configurato dei campi, questi vengono visualizzati anche nella risposta.
ID LABELS LOCATION CONSENT_STORE_ID LOCATION
REST
Per elencare gli archivi di consensi in un set di dati, utilizza il metodo projects.locations.datasets.consentStores.list
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: l'ID del tuo Google Cloud progetto
- DATASET_ID: il set di dati principale dell'archivio del consenso
- LOCATION: la posizione del set di dati
Per inviare la richiesta, scegli una di queste opzioni:
curl
Esegui questo 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
Esegui questo 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
Explorer API
Apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Explorer API. Puoi interagire con questo strumento per inviare richieste. Completa i campi obbligatori e fai clic su Esegui.
ConsentStore
hai configurato dei campi, questi vengono visualizzati anche nella risposta.
Node.js
Python
Eliminazione di un archivio di consensi
Gli esempi riportati di seguito mostrano come eliminare un archivio dei consensi.
Console
Per eliminare un datastore:
- Nella console Google Cloud , vai alla pagina Set di dati.
- Seleziona il set di dati contenente il datastore da eliminare.
- Scegli Elimina dall'elenco a discesa Azioni per l'datastore che vuoi eliminare.
- Per confermare, digita il nome del datastore e fai clic su Elimina.
gcloud
Per eliminare un archivio dei consensi, esegui il comando gcloud healthcare consent-stores delete
.
Prima di utilizzare i dati dei comandi riportati di seguito, effettua le seguenti sostituzioni:
- LOCATION: la posizione del set di dati
- DATASET_ID: il set di dati principale dell'archivio del consenso
- CONSENT_STORE_ID: l'ID dell'archivio del consenso
Esegui questo 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
Per eliminare un archivio del consenso, utilizza il metodo projects.locations.datasets.consentStores.delete
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: l'ID del tuo Google Cloud progetto
- LOCATION: la posizione del set di dati
- DATASET_ID: il set di dati principale dell'archivio del consenso
- CONSENT_STORE_ID: l'ID dell'archivio del consenso
Per inviare la richiesta, scegli una di queste opzioni:
curl
Esegui questo 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
Esegui questo 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
Explorer API
Apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Explorer API. Puoi interagire con questo strumento per inviare richieste. Completa i campi obbligatori e fai clic su Esegui.
Dovresti ricevere una risposta JSON simile alla seguente:
Node.js
Python
Audit logging
L'API Consent Management scrive i seguenti tipi di log di controllo:
- Attività di amministrazione: registra le operazioni che modificano la configurazione o i metadati di una risorsa. Non puoi disabilitare gli audit log delle attività di amministrazione.
- Accesso ai dati: contengono chiamate API che leggono la configurazione o i metadati delle risorse, nonché chiamate API esterne che creano, modificano o leggono i dati delle risorse forniti dal cliente. Questi log devono essere abilitati. Ad esempio, gli audit log di accesso ai dati possono essere utilizzati per registrare quale servizio ha effettuato una richiesta di determinazione dell'accesso, quali informazioni sono state fornite in questa richiesta e come l'API ha risposto alla richiesta. Per ulteriori informazioni sugli audit log di accesso ai dati, consulta la pagina Configurazione degli audit log di accesso ai dati. Per saperne di più sull'audit logging nell'API Cloud Healthcare, consulta Visualizzazione degli audit log di Cloud.
Per ulteriori informazioni sui log di controllo per l'API Consent Management, vedi Visualizzazione degli audit log di Cloud.