Esta página mostra como criar e gerir armazenamentos de consentimento.
A API Consent Management é uma ferramenta para registar consentimentos dos utilizadores, gerir ações com base nesses consentimentos e manter a documentação e os registos associados.
A organização que usa a API Consent Management é responsável por obter e manter os consentimentos necessários para permitir o tratamento de quaisquer dados através da API Consent Management.
A API Consent Management cumpre a função de um ponto de decisão de políticas. A aplicação das políticas tem de ser implementada na aplicação ou através de um proxy. Para mais informações, consulte o artigo Controlo de acesso baseado em atributos.
Configure as autorizações
Para usar as funcionalidades neste guia, tem de ter a
roles/healthcare.consentStoreAdmin
função. No entanto, para realizar operações úteis adicionais com a API Consent Management, podem ser necessárias autorizações adicionais. Consulte o artigo
Controlo de acesso
para ver mais detalhes.
Criar um arquivo de consentimento
Os arquivos de consentimento são os recursos de nível superior que contêm todas as informações relacionadas com a configuração e o funcionamento da API Consent Management. Os arquivos de consentimento pertencem a um conjunto de dados da API Cloud Healthcare, que é atribuído a uma região quando é criado. Esta região é a localização geográfica na qual a sua loja de consentimento opera.
Consola
Na Google Cloud consola, aceda à página Conjuntos de dados.
Selecione o conjunto de dados onde quer criar um armazenamento de consentimento.
Clique em Criar arquivo de dados.
Selecione Consentimento como o tipo de armazenamento de dados.
No campo ID, introduza um nome à sua escolha que seja exclusivo no conjunto de dados. Se o nome não for exclusivo, a criação da loja falha.
Clicar em Seguinte.
Em Configure a sua loja de consentimento, selecione uma das seguintes opções para determinar quando os consentimentos na sua loja expiram:
- Sem tempo de expiração predefinido significa que, por predefinição, os consentimentos não expiram.
- Hora de expiração predefinida significa que, por predefinição, os consentimentos expiram após o número de dias definido no campo Hora de expiração.
Para permitir a criação de novos recursos de consentimento através da API
consentStores.patch
, clique em Permitir a criação de consentimento na atualização.Clicar em Seguinte.
Clique em Adicionar etiqueta para definir chaves e valores opcionais etiquetas para organizar os seus Google Cloud recursos.
Clique em Criar.
gcloud
Para criar uma loja de consentimento, execute o comando gcloud healthcare consent-stores create
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
- CONSENT_STORE_ID:
um identificador para a loja de consentimento. O ID da loja de consentimento tem de ter o seguinte:
- Um ID exclusivo no respetivo conjunto de dados
- Uma string Unicode de 1 a 256 carateres que consiste no seguinte:
- Numbers
- Cartas
- Sublinhados
- Traços
- Períodos
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
Deve receber uma resposta semelhante à seguinte:
Resposta
Created consentStore [CONSENT_STORE_ID].
REST
Para criar um armazenamento de consentimento, use o método projects.locations.datasets.consentStores.create
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
- CONSENT_STORE_ID:
um identificador para a loja de consentimento. O ID da loja de consentimento tem de ter o seguinte:
- Um ID exclusivo no respetivo conjunto de dados
- Uma string Unicode de 1 a 256 carateres que consiste no seguinte:
- Numbers
- Cartas
- Sublinhados
- Traços
- Períodos
- DEFAULT_CONSENT_EXPIRATION_DURATION: um tempo predefinido opcional, especificado em segundos, até que os consentimentos criados nesta loja expirem. Esta duração tem de ser de, pelo menos, 24 horas (86 400 segundos) e tem de estar no formato
DEFAULT_CONSENT_EXPIRATION_DURATIONs
. - ENABLE_CONSENT_CREATE_ON_UPDATE: um valor booleano opcional que determina se os pedidos para aplicar uma correção a um recurso de consentimento inexistente através de
consentStores.patch
devem criar esse recurso. A predefinição éFALSE
.
Corpo JSON do pedido:
{ "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" }
Para enviar o seu pedido, escolha uma destas opções:
curl
Guarde o corpo do pedido num ficheiro denominado request.json
.
Execute o seguinte comando no terminal para criar ou substituir
este ficheiro no diretório atual:
cat > request.json << 'EOF' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } EOF
Em seguida, execute o seguinte comando para enviar o seu pedido 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
Guarde o corpo do pedido num ficheiro denominado request.json
.
Execute o seguinte comando no terminal para criar ou substituir
este ficheiro no diretório atual:
@' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } '@ | Out-File -FilePath request.json -Encoding utf8
Em seguida, execute o seguinte comando para enviar o seu pedido REST:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID" | Select-Object -Expand Content
Explorador de APIs
Copie o corpo do pedido e abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Cole o corpo do pedido nesta ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.
Deve receber uma resposta JSON semelhante à seguinte:
Node.js
Python
Editar uma loja de consentimento
Depois de criar um armazenamento de consentimento, pode atualizá-lo. Por exemplo, pode adicionar ou remover etiquetas para organizar as suas lojas de consentimento.
Os exemplos seguintes mostram como editar um armazenamento de consentimento.
Consola
Para editar um armazenamento de consentimento, conclua os seguintes passos:
- Na Google Cloud consola, aceda à página Conjuntos de dados.
- Selecione o conjunto de dados que contém o armazenamento de consentimento que quer editar.
- Na lista Armazenamentos de dados, clique no armazenamento de dados que quer editar.
- Para editar a configuração do armazenamento de consentimento, clique no ícone de edição junto a Configuração do armazenamento de consentimento.
Para mais informações sobre as opções de configuração do armazenamento de consentimento, consulte o artigo Criar um armazenamento de consentimento. - Para adicionar uma ou mais etiquetas à loja, clique em Usar etiquetas de recursos. Etiquetas, clique em Adicionar etiqueta e introduza a etiqueta de chave/valor. Para mais informações sobre etiquetas de recursos, consulte o artigo
- Clique em Guardar.
gcloud
Para editar um armazenamento de consentimento, execute o comando gcloud healthcare consent-stores update
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
- CONSENT_STORE_ID: o ID da loja de consentimento
- KEY: a chave num par de chave-valor usado para organizar as lojas de consentimento. Consulte
labels
para ver os requisitos e as limitações das etiquetas. - VALUE: o valor num par de chave-valor usado para organizar as lojas de consentimento. Consulte
labels
para ver os requisitos e as limitações das etiquetas.
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
Deve receber uma resposta semelhante à seguinte:
Resposta
Updated consentStore [CONSENT_STORE_ID]. labels: KEY: VALUE name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Para editar um armazenamento de consentimento, use o método projects.locations.datasets.consentStores.patch
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
- CONSENT_STORE_ID: o ID da loja de consentimento
- KEY: a chave num par de chave-valor usado para organizar as lojas de consentimento. Consulte
labels
para ver os requisitos e as limitações das etiquetas. - VALUE: o valor num par de chave-valor usado para organizar as lojas de consentimento. Consulte
labels
para ver os requisitos e as limitações das etiquetas.
Corpo JSON do pedido:
{ "labels": { "KEY": "VALUE" } }
Para enviar o seu pedido, escolha uma destas opções:
curl
Guarde o corpo do pedido num ficheiro denominado request.json
.
Execute o seguinte comando no terminal para criar ou substituir
este ficheiro no diretório atual:
cat > request.json << 'EOF' { "labels": { "KEY": "VALUE" } } EOF
Em seguida, execute o seguinte comando para enviar o seu pedido 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
Guarde o corpo do pedido num ficheiro denominado request.json
.
Execute o seguinte comando no terminal para criar ou substituir
este ficheiro no diretório atual:
@' { "labels": { "KEY": "VALUE" } } '@ | Out-File -FilePath request.json -Encoding utf8
Em seguida, execute o seguinte comando para enviar o seu pedido REST:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels" | Select-Object -Expand Content
Explorador de APIs
Copie o corpo do pedido e abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Cole o corpo do pedido nesta ferramenta, preencha todos os outros campos obrigatórios e clique em Executar.
Deve receber uma resposta JSON semelhante à seguinte:
Node.js
Python
A obter detalhes da loja de consentimento
Os exemplos seguintes mostram como obter detalhes sobre um armazenamento de consentimento.
Consola
Para ver os detalhes de uma loja de consentimento:
- Na Google Cloud consola, aceda à página Conjuntos de dados.
- Selecione o conjunto de dados que contém o armazenamento de consentimento que quer ver.
- Clique no nome da loja de consentimento.
A página Detalhes do arquivo de dados apresenta os detalhes do arquivo de dados de consentimento selecionado.
gcloud
Para obter detalhes sobre um armazenamento de consentimento, execute o comando gcloud healthcare consent-stores describe
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento 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
ConsentStore
, estes também aparecem na resposta.
Resposta
name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Para obter detalhes sobre um armazenamento de consentimento, use o método projects.locations.datasets.consentStores.get
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
- CONSENT_STORE_ID: o ID da loja de consentimento
Para enviar o seu pedido, 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
Explorador de APIs
Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Preencha todos os campos obrigatórios e clique em Executar.
ConsentStore
, estes também aparecem na resposta.
Node.js
Python
Apresentar em lista os arquivos de consentimento num conjunto de dados
Os exemplos seguintes mostram como listar as lojas de consentimento num conjunto de dados.
Consola
Para ver os arquivos de dados num conjunto de dados:
- Na Google Cloud consola, aceda à página Conjuntos de dados.
- Selecione o conjunto de dados que contém o arquivo de dados que quer ver.
gcloud
Para listar os arquivos de consentimento num conjunto de dados, execute o comando gcloud healthcare consent-stores list
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
- LOCATION: a localização 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
ConsentStore
, estes também aparecem na resposta.
ID LABELS LOCATION CONSENT_STORE_ID LOCATION
REST
Para apresentar os armazenamentos de consentimento num conjunto de dados, use o método projects.locations.datasets.consentStores.list
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
- LOCATION: a localização do conjunto de dados
Para enviar o seu pedido, 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
Explorador de APIs
Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Preencha todos os campos obrigatórios e clique em Executar.
ConsentStore
, estes também aparecem na resposta.
Node.js
Python
Eliminar uma loja de consentimento
Os exemplos seguintes mostram como eliminar um armazenamento de consentimento.
Consola
Para eliminar um arquivo de dados:
- Na Google Cloud consola, aceda à página Conjuntos de dados.
- Selecione o conjunto de dados que contém o arquivo de dados que quer eliminar.
- Escolha Eliminar na lista pendente Ações para o arquivo de dados que quer eliminar.
- Para confirmar, escreva o nome do arquivo de dados e, de seguida, clique em Eliminar.
gcloud
Para eliminar um armazenamento de consentimento, execute o comando gcloud healthcare consent-stores delete
.
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento 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
Deleted consentStore [CONSENT_STORE_ID].
REST
Para eliminar um arquivo de consentimento, use o método projects.locations.datasets.consentStores.delete
.
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: o ID do seu Google Cloud projeto
- LOCATION: a localização do conjunto de dados
- DATASET_ID: o conjunto de dados principal do armazenamento de consentimento
- CONSENT_STORE_ID: o ID da loja de consentimento
Para enviar o seu pedido, 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
Explorador de APIs
Abra a página de referência do método. O painel APIs Explorer é aberto no lado direito da página. Pode interagir com esta ferramenta para enviar pedidos. Preencha todos os campos obrigatórios e clique em Executar.
Deve receber uma resposta JSON semelhante à seguinte:
Node.js
Python
Registo de auditoria
A API Consent Management escreve os seguintes tipos de registos de auditoria:
- Atividade de administrador: registe operações que modificam a configuração ou os metadados de um recurso. Não pode desativar os registos de auditoria da atividade do administrador.
- Acesso aos dados: contêm chamadas API que leem a configuração ou os metadados dos recursos, bem como chamadas API externas que criam, modificam ou leem dados de recursos fornecidos pelo cliente. Estes registos têm de estar ativados. Por exemplo, os registos de auditoria de acesso a dados podem ser usados para registar que serviço fez um pedido de determinação de acesso, que informações foram fornecidas nesse pedido e como a API respondeu a esse pedido. Para mais informações sobre os registos de auditoria de acesso a dados, consulte o artigo Configurar registos de auditoria de acesso a dados. Para mais informações sobre o registo de auditoria na Cloud Healthcare API, visite o artigo Visualizar registos de auditoria do Cloud.
Para mais informações sobre os registos de auditoria da API Consent Management, consulte o artigo Ver registos de auditoria do Cloud.