Creazione e gestione degli archivi di consensi

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 gestire la documentazione e i record associati.

L'organizzazione che utilizza l'API Consent Management è responsabile di ottenere e mantenere i consensi richiesti necessari per consentire il trattamento di qualsiasi dato tramite l'API Consent Management.

L'API Consent Management svolge il ruolo di punto decisionale relativo alle norme. L'applicazione dei criteri 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à in questa guida, devi avere il ruolo roles/healthcare.consentStoreAdmin. Tuttavia, per eseguire ulteriori operazioni utili con l'API Consent Management, potrebbero essere necessarie autorizzazioni aggiuntive. Per ulteriori dettagli, consulta Controllo dell'accesso.

Creazione di un archivio di consensi

Gli archivi di consensi sono le risorse di primo livello contenenti tutte le informazioni relative alla configurazione e al funzionamento dell'API Consent Management. Gli archivi di 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 l'archivio di consensi.

Nella console Google Cloud, vai alla pagina Set di dati.

Vai a Set di dati
Seleziona il set di dati in cui vuoi creare un archivio di consensi.
Fai clic su Crea datastore.
Seleziona Consenso come tipo di datastore.
Nel campo ID, inserisci un nome a tua scelta univoco nel set di dati. Se il nome non è univoco, la creazione dello store non riesce.
Tocca Avanti.
In Configura l'archivio di consensi, seleziona una delle seguenti opzioni per determinare quando scadono i consensi nel tuo archivio:
- Nessuna scadenza predefinita significa che, per impostazione predefinita, i consensi non hanno scadenza.
- Scadenza predefinita significa che, per impostazione predefinita, i consensi scadono dopo il numero di giorni definito nel campo Data di scadenza.
Per consentire la creazione di nuove risorse per il consenso utilizzando consentStores.patch, fai clic su Consenti la creazione di consensi al momento dell'aggiornamento.
Tocca Avanti.
Fai clic su Aggiungi etichetta per definire etichette di chiavi e valori facoltative per organizzare le risorse Google Cloud.
Fai clic su Crea.

Per creare un archivio di consensi, esegui il comando gcloud healthcare consent-stores create.

Prima di utilizzare uno qualsiasi dei dati di comando riportati di seguito, effettua le seguenti sostituzioni:

LOCATION: la posizione del set di dati
DATASET_ID: il set di dati padre dell'archivio di consensi
CONSENT_STORE_ID: un identificatore dell'archivio di consensi. L'ID archivio di consensi deve avere quanto segue:
- Un ID univoco nel proprio set di dati
- Una stringa Unicode di 1-256 caratteri costituita da quanto segue:

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].

Per creare un archivio di consensi, usa il metodo projects.locations.datasets.consentStores.create.

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

PROJECT_ID: l'ID del tuo progetto Google Cloud
LOCATION: la posizione del set di dati
DATASET_ID: il set di dati padre dell'archivio di consensi
CONSENT_STORE_ID: un identificatore dell'archivio di consensi. L'ID archivio di consensi deve avere quanto segue:
- Un ID univoco nel proprio set di dati
- Una stringa Unicode di 1-256 caratteri costituita da quanto segue:
DEFAULT_CONSENT_EXPIRATION_DURATION: un intervallo predefinito facoltativo, specificato in secondi, fino alla scadenza dei consensi creati in questo datastore. 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 patch per una risorsa di consenso inesistente utilizzando consentStores.patch devono creare quella 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 delle seguenti opzioni:

arricciatura

Nota: il comando seguente presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login oppure utilizzando Cloud Shell, che ti consente di accedere automaticamente all'interfaccia a riga di comando gcloud. Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json. Esegui questo comando nel terminale per creare o sovrascrivere questo file nella directory attuale:

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 attuale:

@'
{
  "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. Il riquadro Explorer API si apre sul lato destro della pagina. 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
}

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

Modifica di un archivio di consensi

Dopo aver creato un archivio di consensi, puoi aggiornarlo. Ad esempio, puoi aggiungere o rimuovere etichette per organizzare gli archivi di consensi.

Gli esempi riportati di seguito mostrano come modificare un archivio di consensi.

Per modificare un archivio di consensi, segui questi passaggi:

Nella console Google Cloud, vai alla pagina Set di dati.
Vai a Set di dati
Seleziona il set di dati contenente l'archivio di consensi da modificare.
Nell'elenco Datastore, fai clic sul datastore da modificare.
Per modificare la configurazione dell'archivio di consensi, fai clic sull'icona di modifica accanto a Configurazione archivio di consensi.

Per saperne di più sulle opzioni di configurazione dell'archivio di consensi, consulta Creare un archivio di consensi.
Per aggiungere una o più etichette allo store, fai clic su Etichette, poi su Aggiungi etichetta e inserisci l'etichetta chiave/valore. Per saperne di più sulle etichette delle risorse, consulta Utilizzare le etichette delle risorse.
Fai clic su Salva.

Per modificare un archivio di consensi, esegui il comando gcloud healthcare consent-stores update.

Prima di utilizzare uno qualsiasi dei dati di comando riportati di seguito, effettua le seguenti sostituzioni:

LOCATION: la posizione del set di dati
DATASET_ID: il set di dati padre dell'archivio di consensi
CONSENT_STORE_ID: l'ID archivio di consensi
KEY: la chiave in una coppia chiave-valore utilizzata per organizzare gli archivi di consensi. Visita la pagina labels per conoscere i requisiti e le limitazioni delle etichette.
VALUE: il valore in una coppia chiave-valore utilizzata per organizzare gli archivi di consensi. Visita la pagina labels per conoscere 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

Per modificare un archivio di consensi, usa il metodo projects.locations.datasets.consentStores.patch.

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

PROJECT_ID: l'ID del tuo progetto Google Cloud
LOCATION: la posizione del set di dati
DATASET_ID: il set di dati padre dell'archivio di consensi
CONSENT_STORE_ID: l'ID archivio di consensi
KEY: la chiave in una coppia chiave-valore utilizzata per organizzare gli archivi di consensi. Visita la pagina labels per conoscere i requisiti e le limitazioni delle etichette.
VALUE: il valore in una coppia chiave-valore utilizzata per organizzare gli archivi di consensi. Visita la pagina labels 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:

arricciatura

Salva il corpo della richiesta in un file denominato request.json. Esegui questo comando nel terminale per creare o sovrascrivere questo file nella directory attuale:

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 attuale:

@'
{
  "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

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"
  }
}

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

Ottenere dettagli sull'archivio di consensi

Gli esempi riportati di seguito mostrano come ottenere dettagli su un archivio di consensi.

Per visualizzare i dettagli di un archivio di consensi:

Nella console Google Cloud, vai alla pagina Set di dati.
Vai a Set di dati
Seleziona il set di dati contenente l'archivio di consensi che vuoi visualizzare.
Fai clic sul nome dell'archivio di consensi.

La pagina Dettagli datastore mostra i dettagli dell'archivio di consensi selezionato.

Per visualizzare i dettagli di un archivio di consensi, esegui il comando gcloud healthcare consent-stores describe.

Prima di utilizzare uno qualsiasi dei dati di comando riportati di seguito, effettua le seguenti sostituzioni:

LOCATION: la posizione del set di dati
DATASET_ID: il set di dati padre dell'archivio di consensi
CONSENT_STORE_ID: l'ID archivio di consensi

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

Se hai configurato dei campi nella risorsa ConsentStore, 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 di consensi, usa il metodo projects.locations.datasets.consentStores.get.

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

PROJECT_ID: l'ID del tuo progetto Google Cloud
LOCATION: la posizione del set di dati
DATASET_ID: il set di dati padre dell'archivio di consensi
CONSENT_STORE_ID: l'ID archivio di consensi

Per inviare la richiesta, scegli una delle seguenti opzioni:

arricciatura

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. Il riquadro Explorer API si apre sul lato destro della pagina. Puoi interagire con questo strumento per inviare richieste. Compila tutti i campi obbligatori e fai clic su Esegui.

Se nella risorsa 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"
}

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

Elenco degli archivi di consensi in un set di dati

I seguenti esempi mostrano come elencare gli archivi di 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.
Vai a Set di dati
Seleziona il set di dati contenente il datastore da visualizzare.

Per elencare gli archivi di consensi in un set di dati, esegui il comando gcloud healthcare consent-stores list.

Prima di utilizzare uno qualsiasi dei dati di comando riportati di seguito, effettua le seguenti sostituzioni:

DATASET_ID: il set di dati padre dell'archivio di consensi
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

Se hai configurato dei campi nella risorsa ConsentStore, vengono visualizzati anche nella risposta.

ID               LABELS  LOCATION
CONSENT_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, effettua le seguenti sostituzioni:

PROJECT_ID: l'ID del tuo progetto Google Cloud
DATASET_ID: il set di dati padre dell'archivio di consensi
LOCATION: la posizione del set di dati

Per inviare la richiesta, scegli una delle seguenti opzioni:

arricciatura

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

Se nella risorsa 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"
    },
    {
      ...
    }
  ]
}

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

Eliminazione di un archivio di consensi

Gli esempi riportati di seguito mostrano come eliminare un archivio di consensi.

Per eliminare un datastore:

Nella console Google Cloud, vai alla pagina Set di dati.
Vai a Set di dati
Seleziona il set di dati contenente il datastore da eliminare.
Scegli Elimina dall'elenco a discesa Azioni per il datastore da eliminare.
Per confermare, digita il nome del datastore e fai clic su Elimina.

Per eliminare un archivio di consensi, esegui il comando gcloud healthcare consent-stores delete.

Prima di utilizzare uno qualsiasi dei dati di comando riportati di seguito, effettua le seguenti sostituzioni:

LOCATION: la posizione del set di dati
DATASET_ID: il set di dati padre dell'archivio di consensi
CONSENT_STORE_ID: l'ID archivio di consensi

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

Per confermare, digita Y. Dovresti ricevere una risposta simile alla seguente.

Deleted consentStore [CONSENT_STORE_ID].

Per eliminare un archivio di consensi, usa il metodo projects.locations.datasets.consentStores.delete.

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

PROJECT_ID: l'ID del tuo progetto Google Cloud
LOCATION: la posizione del set di dati
DATASET_ID: il set di dati padre dell'archivio di consensi
CONSENT_STORE_ID: l'ID archivio di consensi

Per inviare la richiesta, scegli una delle seguenti opzioni:

arricciatura

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

Dovresti ricevere una risposta JSON simile alla seguente:

Risposta

{}

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

Audit logging

L'API Consent Management scrive i seguenti tipi di audit log:

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: contiene 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 in tale richiesta e la modalità di risposta dell'API alla richiesta. Per ulteriori informazioni sugli audit log di accesso ai dati, consulta Configurazione degli audit log di accesso ai dati. Per ulteriori informazioni sull'audit logging nell'API Cloud Healthcare, visita la pagina Visualizzazione di audit log di Cloud.

Per saperne di più sugli audit log per l'API Consent Management, consulta Visualizzare gli audit log di Cloud.

Creazione e gestione degli archivi di consensi

Configurare le autorizzazioni

Creazione di un archivio di consensi

Console

gcloud

Linux, macOS o Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Risposta

REST

arricciatura

PowerShell

Explorer API

Risposta

Node.js

Python

Modifica di un archivio di consensi

Console

gcloud

Linux, macOS o Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Risposta

REST

arricciatura

PowerShell

Explorer API

Risposta

Node.js

Python

Ottenere dettagli sull'archivio di consensi

Console

gcloud

Linux, macOS o Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Risposta

REST

arricciatura

PowerShell

Explorer API

Risposta

Node.js

Python

Elenco degli archivi di consensi in un set di dati

Console

gcloud

Linux, macOS o Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

arricciatura

PowerShell

Explorer API

Risposta

Node.js

Python

Eliminazione di un archivio di consensi

Console

gcloud

Linux, macOS o Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

arricciatura

PowerShell

Explorer API

Risposta

Node.js

Python

Audit logging