Como criar e gerenciar lojas de consentimento

Esta página mostra como criar e gerenciar repositórios de consentimentos.

A API Consent Management é uma ferramenta para registrar consentimentos do usuário, gerenciar ações com base nesses consentimentos e manter a documentação e os registros associados.

A organização que usa a API Consent Management é responsável por conseguir e manter os consentimentos necessários para permitir o processamento dos dados por meio dessa API.

A API Consent Management cumpre o papel de ponto de decisão de uma política. A aplicação da política precisa ser implementada no aplicativo ou por meio de um proxy. Para mais informações, consulte Controle de acesso baseado em atributos.

Configurar permissões

Para usar os recursos neste guia, você precisa ter o papel roles/healthcare.consentStoreAdmin. No entanto, para realizar outras operações úteis com a API Consent Management, são necessárias outras permissões. Consulte Controle de acesso para mais detalhes.

Como criar um repositório de consentimentos

Os repositórios de consentimentos são o recurso de nível superior em que estão todas as informações relacionadas à configuração e à operação da API Consent Management. Os armazenamentos de consentimento pertencem a um conjunto de dados da API Cloud Healthcare, que é atribuído a uma região quando eles são criados. Essa região é a localização geográfica em que o repositório de consentimentos opera.

No console do Google Cloud, acesse a página Conjuntos de dados.

Acessar conjuntos de dados
Abra o conjunto de dados em que você quer criar um repositório de consentimentos.
Clique em Criar armazenamento de dados.
Selecione Consentimento como o tipo de armazenamento de dados.
No campo ID, insira um nome de sua escolha exclusivo no conjunto de dados. Se o nome não for exclusivo, a criação do repositório falhará.
Clique em Próxima.
Em Configurar seu repositório de consentimentos, selecione uma das seguintes opções para determinar quando os consentimentos no seu armazenamento expiram:
- Sem prazo de validade padrão significa que os consentimentos não expiram por padrão.
- Prazo de validade padrão significa que, por padrão, os consentimentos expiram após o número de dias definido no campo Prazo de validade.
Para permitir que novos recursos de consentimento sejam criados usando o consentStores.patch, clique em Permitir a criação de consentimento ao atualizar.
Clique em Próxima.
Clique em Adicionar rótulo para definir os rótulos de chave e valor para organizar os recursos do Google Cloud.
Clique em Criar.

Para criar um repositório de consentimento, execute o comando gcloud healthcare consent-stores create.

Antes de usar os dados do comando abaixo, faça estas substituições:

LOCATION: o local do conjunto de dados;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
CONSENT_STORE_ID: um identificador do repositório de consentimentos. O ID do repositório de consentimento precisa ter o seguinte:
- Um ID exclusivo no conjunto de dados
- Uma string Unicode de 1 a 256 caracteres, que consiste no seguinte:

Execute o seguinte comando:

Linux, macOS ou 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

Você receberá uma resposta semelhante a esta:

Resposta

Created consentStore [CONSENT_STORE_ID].

Para criar um repositório de consentimentos, use o método projects.locations.datasets.consentStores.create.

Antes de usar os dados da solicitação, faça as substituições a seguir:

PROJECT_ID: o ID do seu projeto do Google Cloud;
LOCATION: o local do conjunto de dados;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
CONSENT_STORE_ID: um identificador do repositório de consentimentos. O ID do repositório de consentimento precisa ter o seguinte:
- Um ID exclusivo no conjunto de dados
- Uma string Unicode de 1 a 256 caracteres, que consiste no seguinte:
DEFAULT_CONSENT_EXPIRATION_DURATION: um tempo padrão opcional, especificado em segundos, até que os consentimentos criados nessa loja expirem. Essa duração precisa ser de pelo menos 24 horas (86.400 segundos) e estar no formato DEFAULT_CONSENT_EXPIRATION_DURATIONs.
ENABLE_CONSENT_CREATE_ON_UPDATE: um booleano opcional que determina se as solicitações para corrigir um recurso de consentimento inexistente usando consentStores.patch precisam criar esse recurso. O padrão é FALSE.

Solicitar corpo JSON:

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

Para enviar a solicitação, escolha uma destas opções:

curl

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. É possível verificar a conta ativa atualmente executando gcloud auth list.

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

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

Depois execute o comando a seguir para enviar a solicitação 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

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

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

Depois execute o comando a seguir para enviar a solicitação 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

APIs Explorer

Copie o corpo da solicitação e abra a página de referência do método. O painel "APIs Explorer" é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Cole o corpo da solicitação nessa ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.

Você receberá uma resposta JSON semelhante a esta:

Resposta

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

Como editar um repositório de consentimento

Depois de criar um repositório de consentimento, você pode atualizá-lo. Por exemplo, você pode adicionar ou remover rótulos para organizar seus repositórios de consentimento.

Os exemplos a seguir mostram como editar um repositório de consentimentos.

Para editar um repositório de consentimentos, siga estas etapas:

No console do Google Cloud, acesse a página Conjuntos de dados.
Acessar conjuntos de dados
Selecione o conjunto de dados em que está o repositório de consentimentos que você quer editar.
Na lista Armazenamentos de dados, clique no armazenamento de dados que você quer editar.
Para editar a configuração do repositório de consentimentos, clique no ícone de edição ao lado de Configuração do repositório de consentimentos.

Para ver mais informações sobre as opções de configuração do repositório de consentimentos, consulte Como criar um repositório de consentimentos.
Para adicionar um ou mais rótulos ao armazenamento, clique em Rótulos, em Adicionar rótulo e insira o rótulo de chave-valor. Para mais informações sobre rótulos de recursos, consulte Como usar rótulos de recursos.
Clique em Salvar.

Para editar um repositório de consentimento, execute o comando gcloud healthcare consent-stores update.

Antes de usar os dados do comando abaixo, faça estas substituições:

LOCATION: o local do conjunto de dados;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento
KEY: a chave em um par de chave-valor usado para organizar armazenamentos de consentimento. Consulte labels para conferir os requisitos e as limitações para marcadores.
VALUE: o valor em um par de chave-valor usado para organizar armazenamentos de consentimento. Consulte labels para conferir os requisitos e as limitações para marcadores.

Execute o seguinte comando:

Linux, macOS ou 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

Você receberá uma resposta semelhante a esta:

Resposta

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

Para editar um repositório de consentimentos, use o método projects.locations.datasets.consentStores.patch.

Antes de usar os dados da solicitação, faça as substituições a seguir:

PROJECT_ID: o ID do seu projeto do Google Cloud;
LOCATION: o local do conjunto de dados;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento
KEY: a chave em um par de chave-valor usado para organizar armazenamentos de consentimento. Consulte labels para conferir os requisitos e as limitações para marcadores.
VALUE: o valor em um par de chave-valor usado para organizar armazenamentos de consentimento. Consulte labels para conferir os requisitos e as limitações para marcadores.

Solicitar corpo JSON:

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

Para enviar a solicitação, escolha uma destas opções:

curl

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

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

Depois execute o comando a seguir para enviar a solicitação 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

Salve o corpo da solicitação em um arquivo chamado request.json. Execute o comando a seguir no terminal para criar ou substituir esse arquivo no diretório atual:

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

Depois execute o comando a seguir para enviar a solicitação 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

APIs Explorer

Você receberá uma resposta JSON semelhante a esta:

Resposta

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

Como ver os detalhes do repositório de consentimentos

Os exemplos a seguir mostram como conseguir detalhes sobre um repositório de consentimentos.

Para ver os detalhes de um repositório de consentimentos:

No console do Google Cloud, acesse a página Conjuntos de dados.
Acessar conjuntos de dados
Selecione o conjunto de dados em que está o repositório de consentimentos que você quer visualizar.
Clique no nome do repositório de consentimentos.

A página Detalhes do Datastore mostra os detalhes do repositório de consentimentos selecionado.

Para acessar detalhes sobre um repositório de consentimentos, execute o comando gcloud healthcare consent-stores describe.

Antes de usar os dados do comando abaixo, faça estas substituições:

LOCATION: o local do conjunto de dados;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento

Execute o seguinte comando:

Linux, macOS ou 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 você configurou algum campo no recurso ConsentStore, ele também aparecerá na resposta.

Resposta

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

Para acessar detalhes sobre um repositório de consentimentos, use o método projects.locations.datasets.consentStores.get.

Antes de usar os dados da solicitação, faça as substituições a seguir:

PROJECT_ID: o ID do seu projeto do Google Cloud;
LOCATION: o local do conjunto de dados;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento

Para enviar a solicitação, escolha uma destas opções:

curl

execute o seguinte 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

execute o seguinte 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

APIs Explorer

Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Interaja com essa ferramenta para enviar solicitações. Preencha todos os campos obrigatórios e clique em Executar.

Se você tiver configurado algum campo no recurso ConsentStore, ele também aparecerá na resposta.

Resposta

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

Como listar os repositórios de consentimentos em um conjunto de dados

Os exemplos a seguir mostram como listar os armazenamentos de consentimento em um conjunto de dados.

Para visualizar os armazenamentos de dados em um conjunto de dados:

No console do Google Cloud, acesse a página Conjuntos de dados.
Acessar conjuntos de dados
Selecione o conjunto de dados que contém o repositório de dados que você quer visualizar.

Para listar os armazenamentos de consentimento em um conjunto de dados, execute o comando gcloud healthcare consent-stores list.

Antes de usar os dados do comando abaixo, faça estas substituições:

DATASET_ID: o conjunto de dados pai do repositório de consentimento
LOCATION: o local do conjunto de dados;

Execute o seguinte comando:

Linux, macOS ou 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 você configurou algum campo no recurso ConsentStore, ele também aparecerá na resposta.

ID               LABELS  LOCATION
CONSENT_STORE_ID           LOCATION

Para listar os armazenamentos de consentimento em um conjunto de dados, use o método projects.locations.datasets.consentStores.list.

Antes de usar os dados da solicitação, faça as substituições a seguir:

PROJECT_ID: o ID do seu projeto do Google Cloud;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
LOCATION: o local do conjunto de dados;

Para enviar a solicitação, escolha uma destas opções:

curl

execute o seguinte 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

execute o seguinte 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

APIs Explorer

Se você tiver configurado algum campo no recurso ConsentStore, ele também aparecerá na resposta.

Resposta

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

Como excluir um repositório de consentimentos

Os exemplos a seguir mostram como excluir um repositório de consentimentos.

Para excluir um repositório de dados:

No console do Google Cloud, acesse a página Conjuntos de dados.
Acessar conjuntos de dados
Selecione o conjunto de dados que contém o armazenamento de dados que você quer excluir.
Escolha Excluir na lista suspensa Ações para o armazenamento de dados que você quer excluir.
Para confirmar, digite o nome do repositório de dados e clique em Excluir.

Para excluir um repositório de consentimento, execute o comando gcloud healthcare consent-stores delete.

Antes de usar os dados do comando abaixo, faça estas substituições:

LOCATION: o local do conjunto de dados;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

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

Windows (PowerShell)

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

Windows (cmd.exe)

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

Para confirmar, digite Y. Você vai receber uma resposta semelhante à seguinte.

Deleted consentStore [CONSENT_STORE_ID].

Para excluir um repositório de consentimento, use o método projects.locations.datasets.consentStores.delete.

Antes de usar os dados da solicitação, faça as substituições a seguir:

PROJECT_ID: o ID do seu projeto do Google Cloud;
LOCATION: o local do conjunto de dados;
DATASET_ID: o conjunto de dados pai do repositório de consentimento
CONSENT_STORE_ID: o ID da loja de consentimento

Para enviar a solicitação, escolha uma destas opções:

curl

execute o seguinte 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

execute o seguinte 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

APIs Explorer

Você receberá uma resposta JSON semelhante a esta:

Resposta

{}

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

Registro de auditoria

A API Consent Management grava os seguintes tipos de registros de auditoria:

Atividade do administrador: registra operações que modificam a configuração ou os metadados de um recurso. Não é possível desativar esses registros.
Acesso a dados: contém chamadas de API que leem a configuração ou os metadados de recursos, além de chamadas de API externas que criam, modificam ou leem dados de recursos fornecidos pelo cliente. Esses registros precisam estar ativados. Por exemplo, os registros de auditoria de acesso a dados podem ser usados para registrar qual serviço fez uma solicitação de determinação de acesso, quais informações foram fornecidas nessa solicitação e como a API respondeu a essa solicitação. Veja mais informações sobre os registros de auditoria de acesso a dados em Como configurar registros de auditoria de acesso a dados. Para mais informações sobre a geração de registros de auditoria na API Cloud Healthcare, acesse Como visualizar registros de auditoria do Cloud.

Para mais informações sobre registros de auditoria da API Consent Management, consulte Como visualizar registros de auditoria do Cloud.

Como criar e gerenciar lojas de consentimento

Configurar permissões

Como criar um repositório de consentimentos

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Resposta

REST

curl

PowerShell

APIs Explorer

Resposta

Node.js

Python

Como editar um repositório de consentimento

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Resposta

REST

curl

PowerShell

APIs Explorer

Resposta

Node.js

Python

Como ver os detalhes do repositório de consentimentos

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Resposta

REST

curl

PowerShell

APIs Explorer

Resposta

Node.js

Python

Como listar os repositórios de consentimentos em um conjunto de dados

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl

PowerShell

APIs Explorer

Resposta

Node.js

Python

Como excluir um repositório de consentimentos

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl

PowerShell

APIs Explorer

Resposta

Node.js

Python

Registro de auditoria