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 basate su questi consensi e gestire 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 l'elaborazione di qualsiasi dato tramite l'API Consent Management.
L'API Consent Management svolge il ruolo di un punto di decisione sulle 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 disporre del
roles/healthcare.consentStoreAdmin
ruolo. Tuttavia, per eseguire ulteriori operazioni utili con l'API di gestione del consenso, potrebbero essere necessarie autorizzazioni aggiuntive. Per ulteriori dettagli, consulta Controllo dell'accesso.
Creazione di un archivio di consensi
Gli store dei consensi sono le risorse di primo livello che contengono tutte le informazioni relative alla configurazione e al funzionamento dell'API Consent Management. Gli archivi dei consensi 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 negozio del consenso.
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 data store.
Nel campo ID, inserisci un nome a tua scelta che sia univoco nel set di dati. Se il nome non è univoco, la creazione del negozio non va a buon fine.
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.
- Per Scadenza predefinita si intende 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 Consenti 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 tue risorseGoogle Cloud .
Fai clic su Crea.
Per creare un archivio dei 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 datiDATASET_ID : il set di dati principale del negozio del consensoCONSENT_STORE_ID : un identificatore per l'archivio dei consensi. L'ID del negozio del consenso deve avere quanto segue:- Un ID univoco nel set di dati
- Una stringa Unicode di 1-256 caratteri composta da quanto segue:
- Numeri
- Lettere
- Trattini bassi
- Trattini
- Punti
Esegui il seguente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores createCONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores createCONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores createCONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
Dovresti ricevere una risposta simile alla seguente:
Risposta
Created consentStore [CONSENT_STORE_ID ].
Per creare un archivio dei consensi, 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 progettoLOCATION : la posizione del set di datiDATASET_ID : il set di dati principale del negozio del consensoCONSENT_STORE_ID : un identificatore per l'archivio dei consensi. L'ID del negozio del consenso deve avere quanto segue:- Un ID univoco nel set di dati
- Una stringa Unicode di 1-256 caratteri composta da quanto segue:
- Numeri
- Lettere
- Trattini bassi
- Trattini
- Punti
DEFAULT_CONSENT_EXPIRATION_DURATION : un'ora predefinita facoltativa, specificata in secondi, fino alla scadenza dei consensi creati in questo archivio. La durata deve essere di almeno 24 ore (86.400 secondi) e deve essere nel formatoDEFAULT_CONSENT_EXPIRATION_DURATIONs
.ENABLE_CONSENT_CREATE_ON_UPDATE : un valore booleano facoltativo che determina se le richieste di correzione di una risorsa per il consenso non esistente utilizzandoconsentStores.patch
devono creare la risorsa. Il valore predefinito èFALSE
.
Corpo JSON della richiesta:
{ "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATION s", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE " }
Per inviare la richiesta, scegli una delle seguenti opzioni:
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_DURATION s", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE " } EOF
Quindi, esegui il seguente 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 "
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_DURATION s", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE " } '@ | Out-File -FilePath request.json -Encoding utf8
Quindi, esegui il seguente 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
Copia il corpo della richiesta e apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Esplora 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:
Risposta
{ "name": "projects/PROJECT_ID /locations/LOCATION /datasets/DATASET_ID /consentStores/CONSENT_STORE_ID ", "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATION ", "enableConsentCreateOnUpdate":ENABLE_CONSENT_CREATE_ON_UPDATE }
Modificare un archivio di consensi
Dopo aver creato un archivio dei consensi, puoi aggiornarlo. Ad esempio, puoi aggiungere o rimuovere etichette per organizzare i tuoi datastore per il consenso.
Gli esempi riportati di seguito mostrano come modificare un archivio dei consensi.
Per modificare un archivio dei consensi:
- Nella console Google Cloud, vai alla pagina Set di dati.
- Seleziona il set di dati contenente l'archivio del consenso da modificare.
- Nell'elenco Datastore, fai clic sul datastore da modificare.
- Per modificare la configurazione del negozio del consenso, fai clic sull'icona di modifica accanto a Configurazione del negozio del consenso.
Per ulteriori informazioni sulle opzioni di configurazione del negozio del consenso, consulta Creare un negozio del consenso. - Per aggiungere una o più etichette al negozio, fai clic su Utilizzare le etichette delle risorse. Etichette, poi su Aggiungi etichetta e inserisci l'etichetta chiave/valore. Per saperne di più sulle etichette delle risorse, vedi
- Fai clic su Salva.
Per modificare un archivio dei consensi, 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 datiDATASET_ID : il set di dati principale del negozio del consensoCONSENT_STORE_ID : l'ID store del consensoKEY : la chiave di una coppia chiave-valore utilizzata per organizzare gli store del consenso. Consulta la paginalabels
per conoscere i requisiti e le limitazioni delle etichette.VALUE : il valore in una coppia chiave-valore utilizzata per organizzare gli store del consenso. Consulta la paginalabels
per conoscere i requisiti e le limitazioni delle etichette.
Esegui il seguente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores updateCONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION \ --update-labels=KEY =VALUE
Windows (PowerShell)
gcloud healthcare consent-stores updateCONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION ` --update-labels=KEY =VALUE
Windows (cmd.exe)
gcloud healthcare consent-stores updateCONSENT_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
Per modificare un archivio dei consensi, 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 progettoLOCATION : la posizione del set di datiDATASET_ID : il set di dati principale del negozio del consensoCONSENT_STORE_ID : l'ID store del consensoKEY : la chiave di una coppia chiave-valore utilizzata per organizzare gli store del consenso. Consulta la paginalabels
per conoscere i requisiti e le limitazioni delle etichette.VALUE : il valore in una coppia chiave-valore utilizzata per organizzare gli store del consenso. Consulta la paginalabels
per conoscere i requisiti e le limitazioni delle etichette.
Corpo JSON della richiesta:
{ "labels": { "KEY ": "VALUE " } }
Per inviare la richiesta, scegli una delle seguenti opzioni:
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 il seguente 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"
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 il seguente 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
Copia il corpo della richiesta e apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Esplora 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:
Risposta
{ "name": "projects/PROJECT_ID /locations/LOCATION /datasets/DATASET_ID /consentStores/CONSENT_STORE_ID ", "labels": { "KEY ": "VALUE " } }
Recuperare i dettagli dell'archivio dei consensi
Gli esempi riportati di seguito mostrano come recuperare i dettagli di un archivio dei consensi.
Per visualizzare i dettagli di un archivio dei consensi:
- 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 dei consensi.
La pagina Dettagli del datastore mostra i dettagli dell'archivio dei consensi selezionato.
Per visualizzare i dettagli di un archivio dei consensi, 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 datiDATASET_ID : il set di dati principale del negozio del consensoCONSENT_STORE_ID : l'ID store del consenso
Esegui il seguente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores describeCONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores describeCONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores describeCONSENT_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
Per visualizzare i dettagli di un archivio dei consensi, 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 progettoLOCATION : la posizione del set di datiDATASET_ID : il set di dati principale del negozio del consensoCONSENT_STORE_ID : l'ID store del consenso
Per inviare la richiesta, scegli una delle seguenti opzioni:
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 "
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
Apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Esplora API. Puoi interagire con questo strumento per inviare richieste. Compila i campi obbligatori e fai clic su Esegui.
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 " }
Elenco degli archivi di consensi in un set di dati
Gli esempi riportati di seguito mostrano come elencare gli archivi dei consensi in un set di dati.
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 data store che vuoi visualizzare.
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 del negozio del consensoLOCATION : la posizione del set di dati
Esegui il seguente 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 LOCATIONCONSENT_STORE_ID LOCATION
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 progettoDATASET_ID : il set di dati principale del negozio del consensoLOCATION : la posizione del set di dati
Per inviare la richiesta, scegli una delle seguenti opzioni:
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"
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
Apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Esplora API. Puoi interagire con questo strumento per inviare richieste. Compila i campi obbligatori e fai clic su Esegui.
ConsentStore
hai configurato dei campi, questi vengono visualizzati anche nella risposta.
Risposta
{ "consentStores": [ { "name": "projects/PROJECT_ID /locations/LOCATION /datasets/DATASET_ID /consentStores/CONSENT_STORE_ID " }, { ... } ] }
Eliminazione di un archivio dei consensi
Gli esempi riportati di seguito mostrano come eliminare un archivio dei consensi.
Per eliminare un datastore:
- Nella console Google Cloud, vai alla pagina Set di dati.
- Seleziona il set di dati contenente il data store da eliminare.
- Scegli Elimina dall'elenco a discesa Azioni per l'area di archiviazione dei dati che vuoi eliminare.
- Per confermare, digita il nome del data store e fai clic su Elimina.
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 datiDATASET_ID : il set di dati principale del negozio del consensoCONSENT_STORE_ID : l'ID store del consenso
Esegui il seguente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores deleteCONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores deleteCONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores deleteCONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
Deleted consentStore [CONSENT_STORE_ID ].
Per eliminare un archivio dei consensi, 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 progettoLOCATION : la posizione del set di datiDATASET_ID : il set di dati principale del negozio del consensoCONSENT_STORE_ID : l'ID store del consenso
Per inviare la richiesta, scegli una delle seguenti opzioni:
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 "
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
Apri la pagina di riferimento del metodo. Sul lato destro della pagina si apre il riquadro Esplora API. Puoi interagire con questo strumento per inviare richieste. Compila i campi obbligatori e fai clic su Esegui.
Dovresti ricevere una risposta JSON simile alla seguente:
Risposta
{}
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 disattivare 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 il servizio che ha effettuato una richiesta di determinazione dell'accesso, le informazioni fornite nella richiesta e la risposta dell'API a questa richiesta. Per ulteriori informazioni sugli audit log di accesso ai dati, consulta la pagina Configurazione degli audit log di accesso ai dati. Per ulteriori informazioni 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.