Cette page a été traduite par l'API Cloud Translation.

Créer et gérer des magasins d'autorisations

Cette page explique comment créer et gérer des magasins d'autorisations.

L'API Consent Management est un outil permettant d'enregistrer les autorisations des utilisateurs, de gérer les actions basées sur ces autorisations et de gérer la documentation et les enregistrements associés.

L'organisation utilisant l'API Consent Management est chargée d'obtenir et de conserver les autorisations requises afin d'autoriser le traitement de toutes les données via l'API Consent Management.

L'API Consent Management gère le rôle d'un point de décision lié à la stratégie. L'application des stratégies doit être mise en œuvre dans l'application ou via un proxy. Pour plus d'informations, consultez la section Contrôle des accès basé sur les attributs.

Configurer les autorisations

Pour utiliser les fonctionnalités de ce guide, vous devez disposer du rôle roles/healthcare.consentStoreAdmin. Toutefois, pour effectuer des opérations utiles supplémentaires avec l'API Consent Management, des autorisations supplémentaires peuvent être nécessaires. Pour en savoir plus, consultez la page Contrôle des accès.

Créer un magasin d'autorisations

Les datastores d'autorisations sont les ressources de premier niveau contenant toutes les informations liées à la configuration et à l'exploitation de l'API Consent Management. Les datastores d'autorisations appartiennent à un ensemble de données de l'API Cloud Healthcare, qui est attribué à une région lors de sa création. Cette région correspond à l'emplacement géographique dans lequel votre datastore d'autorisations fonctionne.

Dans la console Google Cloud, accédez à la page Ensembles de données.

Accéder à la page "Ensembles de données"
Ouvrez l'ensemble de données dans lequel vous souhaitez créer un datastore d'autorisations.
Cliquez sur Créer un datastore.
Sélectionnez Autorisation comme type de datastore.
Dans le champ ID, saisissez le nom de votre choix, qui est unique dans votre ensemble de données. Si le nom n'est pas unique, la création du magasin échoue.
Cliquez sur Next (Suivant).
Dans Configurer votre datastore d'autorisations, sélectionnez l'une des options suivantes pour déterminer la date d'expiration des autorisations dans votre datastore :
- Aucun délai d'expiration par défaut signifie que, par défaut, les autorisations n'expirent pas.
- Délai d'expiration par défautsignifie que, par défaut, les autorisations expirent après le nombre de jours défini dans le champ Heure d'expiration.
Pour autoriser la création de ressources d'autorisation à l'aide de consentStores.patch, cliquez sur Autoriser la création d'autorisations lors de la mise à jour.
Cliquez sur Suivant.
Cliquez sur Ajouter un libellé pour définir les libellés de clé et de valeur facultatifs permettant d'organiser vos ressources Google Cloud.
Cliquez sur Créer.

Pour créer un magasin d'autorisations, exécutez la commande gcloud healthcare consent-stores create.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

LOCATION : emplacement de l'ensemble de données.
DATASET_ID : ensemble de données parent du magasin d'autorisations.
CONSENT_STORE_ID : identifiant du magasin d'autorisations. L'ID du magasin d'autorisations doit comporter les éléments suivants :
- Un ID unique dans son ensemble de données
- Une chaîne Unicode de 1 à 256 caractères composée des éléments suivants :

Exécutez la commande suivante :

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

Vous devriez obtenir un résultat semblable à celui-ci :

Réponse

Created consentStore [CONSENT_STORE_ID].

Pour créer un datastore FHIR, utilisez la méthode projects.locations.datasets.consentStores.create.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

PROJECT_ID : ID de votre projet Google Cloud
LOCATION : emplacement de l'ensemble de données.
DATASET_ID : ensemble de données parent du magasin d'autorisations.
CONSENT_STORE_ID : identifiant du magasin d'autorisations. L'ID du magasin d'autorisations doit comporter les éléments suivants :
- Un ID unique dans son ensemble de données
- Une chaîne Unicode de 1 à 256 caractères composée des éléments suivants :
DEFAULT_CONSENT_EXPIRATION_DURATION : délai par défaut facultatif, spécifié en secondes, jusqu'à l'expiration des autorisations créées dans ce magasin. Cette durée doit être d'au moins 24 heures (86 400 secondes) et être au format DEFAULT_CONSENT_EXPIRATION_DURATIONs.
ENABLE_CONSENT_CREATE_ON_UPDATE : valeur booléenne facultative qui détermine si les requêtes visant à appliquer un correctif à une ressource d'autorisation inexistante à l'aide de consentStores.patch doivent créer cette ressource. La valeur par défaut est FALSE.

Corps JSON de la requête :

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

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

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

Exécutez ensuite la commande suivante pour envoyer votre requête 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

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

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

Exécutez ensuite la commande suivante pour envoyer votre requête 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

API Explorer

Copiez le corps de la requête et ouvrez la page de référence de la méthode. Le panneau APIs Explorer s'ouvre dans la partie droite de la page. Vous pouvez interagir avec cet outil pour envoyer des requêtes. Collez le corps de la requête dans cet outil, renseignez tous les champs obligatoires, puis cliquez sur Execute (Exécuter).

Vous devriez recevoir une réponse JSON de ce type :

Réponse

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

Modifier un datastore d'autorisations

Après avoir créé un magasin d'autorisations, vous pouvez le mettre à jour. Par exemple, vous pouvez ajouter ou supprimer des libellés pour organiser vos magasins d'autorisations.

Les exemples suivants montrent comment modifier un datastore d'autorisations.

Pour modifier un datastore d'autorisations, procédez comme suit :

Dans la console Google Cloud, accédez à la page Ensembles de données.
Accéder à la page "Ensembles de données"
Sélectionnez l'ensemble de données contenant le datastore d'autorisations que vous souhaitez modifier.
Dans la liste Datastores, cliquez sur le magasin que vous souhaitez modifier.
Pour modifier la configuration du datastore d'autorisations, cliquez sur l'icône de modification à côté de Configuration du datastore d'autorisations.

Pour en savoir plus sur les options de configuration du datastore d'autorisations, consultez la page Créer un datastore d'autorisations.
Pour ajouter un ou plusieurs libellés au magasin, cliquez sur Libellés, cliquez sur Ajouter un libellé, puis saisissez le libellé de clé-valeur. Pour en savoir plus sur les libellés de ressources, consultez la page Utiliser des libellés de ressources.
Cliquez sur Enregistrer.

Pour modifier un magasin d'autorisations, exécutez la commande gcloud healthcare consent-stores update.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

LOCATION : emplacement de l'ensemble de données.
DATASET_ID : ensemble de données parent du magasin d'autorisations.
CONSENT_STORE_ID : ID du magasin d'autorisations.
KEY : clé d'une paire clé/valeur utilisée pour organiser les magasins d'autorisations. Pour connaître les exigences et les limites applicables aux libellés, consultez la section labels.
VALUE : valeur d'une paire clé-valeur utilisée pour organiser les magasins d'autorisations. Pour connaître les exigences et les limites applicables aux libellés, consultez la section labels.

Exécutez la commande suivante :

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

Vous devriez obtenir un résultat semblable à celui-ci :

Réponse

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

Pour modifier un datastore FHIR, utilisez la méthode projects.locations.datasets.consentStores.patch.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

PROJECT_ID : ID de votre projet Google Cloud
LOCATION : emplacement de l'ensemble de données.
DATASET_ID : ensemble de données parent du magasin d'autorisations.
CONSENT_STORE_ID : ID du magasin d'autorisations.
KEY : clé d'une paire clé/valeur utilisée pour organiser les magasins d'autorisations. Pour connaître les exigences et les limites applicables aux libellés, consultez la section labels.
VALUE : valeur d'une paire clé-valeur utilisée pour organiser les magasins d'autorisations. Pour connaître les exigences et les limites applicables aux libellés, consultez la section labels.

Corps JSON de la requête :

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

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

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

Exécutez ensuite la commande suivante pour envoyer votre requête 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

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

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

Exécutez ensuite la commande suivante pour envoyer votre requête 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

API Explorer

Vous devriez recevoir une réponse JSON de ce type :

Réponse

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

Obtenir des informations sur un magasin d'autorisations

Les exemples suivants montrent comment obtenir des détails sur un magasin d'autorisations.

Pour afficher les détails d'un datastore FHIR :

Dans la console Google Cloud, accédez à la page Ensembles de données.
Accéder à la page "Ensembles de données"
Sélectionnez l'ensemble de données contenant le datastore d'autorisations que vous souhaitez afficher.
Cliquez sur le nom du datastore d'autorisations.

La page Détails du datastore affiche les détails du magasin d'autorisations sélectionné.

Pour obtenir des détails sur un magasin d'autorisations, exécutez la commande gcloud healthcare consent-stores describe.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

LOCATION : emplacement de l'ensemble de données.
DATASET_ID : ensemble de données parent du magasin d'autorisations.
CONSENT_STORE_ID : ID du magasin d'autorisations.

Exécutez la commande suivante :

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

Si vous avez configuré des champs dans ConsentStore ressource, ils apparaissent également dans la réponse.

Réponse

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

Pour obtenir des détails sur un magasin d'autorisations, utilisez la méthode projects.locations.datasets.consentStores.get.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

PROJECT_ID : ID de votre projet Google Cloud
LOCATION : emplacement de l'ensemble de données.
DATASET_ID : ensemble de données parent du magasin d'autorisations.
CONSENT_STORE_ID : ID du magasin d'autorisations.

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Exécutez la commande suivante :

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

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Exécutez la commande suivante :

$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

API Explorer

Ouvrez la page de référence de la méthode. Le panneau APIs Explorer s'ouvre dans la partie droite de la page. Vous pouvez interagir avec cet outil pour envoyer des requêtes. Renseignez tous les champs obligatoires, puis cliquez sur Execute (Exécuter).

Si vous avez configuré des champs dans la ressource ConsentStore, ils apparaissent également dans la réponse.

Réponse

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

Répertorier les magasins d'autorisations dans un ensemble de données

Les exemples suivants montrent comment répertorier les magasins d'autorisations dans un ensemble de données.

Pour afficher les datastores d'un ensemble de données, procédez comme suit :

Dans la console Google Cloud, accédez à la page Ensembles de données.
Accéder à la page "Ensembles de données"
Sélectionnez l'ensemble de données contenant le datastore que vous souhaitez supprimer.

Pour répertorier les magasins d'autorisations d'un ensemble de données, exécutez la commande gcloud healthcare consent-stores list.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

DATASET_ID : ensemble de données parent du magasin d'autorisations.
LOCATION : emplacement de l'ensemble de données

Exécutez la commande suivante :

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

Si vous avez configuré des champs dans la ressource ConsentStore, ils apparaissent également dans la réponse.

ID               LABELS  LOCATION
CONSENT_STORE_ID           LOCATION

Pour répertorier les magasins d'autorisations dans un ensemble de données, utilisez la méthode projects.locations.datasets.consentStores.list.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

PROJECT_ID : ID de votre projet Google Cloud
DATASET_ID : ensemble de données parent du magasin d'autorisations.
LOCATION : emplacement de l'ensemble de données.

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Exécutez la commande suivante :

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

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Exécutez la commande suivante :

$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

API Explorer

Si vous avez configuré des champs dans la ressource ConsentStore, ils apparaissent également dans la réponse.

Réponse

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

Supprimer un magasin d'autorisations

Les exemples suivants montrent comment supprimer un datastore d'autorisations.

Pour supprimer un datastore, procédez comme suit :

Dans la console Google Cloud, accédez à la page Ensembles de données.
Accéder à la page "Ensembles de données"
Sélectionnez l'ensemble de données contenant le datastore que vous souhaitez supprimer.
Choisissez Supprimer dans la liste déroulante Actions du datastore que vous souhaitez supprimer.
Pour confirmer, saisissez le nom du datastore, puis cliquez sur Supprimer.

Pour supprimer un magasin d'autorisations, exécutez la commande gcloud healthcare consent-stores delete.

Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

LOCATION : emplacement de l'ensemble de données.
DATASET_ID : ensemble de données parent du magasin d'autorisations.
CONSENT_STORE_ID : ID du magasin d'autorisations.

Exécutez la commande suivante :

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

Pour confirmer, saisissez Y. Vous devriez obtenir un résultat semblable au suivant.

Deleted consentStore [CONSENT_STORE_ID].

Pour supprimer un magasin d'autorisations, utilisez la méthode projects.locations.datasets.consentStores.delete.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

PROJECT_ID : ID de votre projet Google Cloud
LOCATION : emplacement de l'ensemble de données.
DATASET_ID : ensemble de données parent du magasin d'autorisations.
CONSENT_STORE_ID : ID du magasin d'autorisations.

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Exécutez la commande suivante :

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

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Exécutez la commande suivante :

$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

API Explorer

Vous devriez recevoir une réponse JSON de ce type :

Réponse

{}

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

Journaux d'audit

L'API Consent Management écrit les types de journaux d'audit suivants :

Activité d'administration : enregistre les opérations qui modifient la configuration ou les métadonnées d'une ressource. Vous ne pouvez pas les désactiver.
Accès aux données : contient les appels d'API qui lisent la configuration ou les métadonnées des ressources, et les appels d'API externes qui créent, modifient ou lisent des données de ressources fournies par le client. Ces journaux doivent être activés. Par exemple, les journaux d'audit pour l'accès aux données peuvent être utilisés pour consigner le service ayant émis une requête de décision d'accès, les informations fournies dans cette requête et la manière dont l'API a répondu à cette requête. Pour en savoir plus sur les journaux d'audit des accès aux données, consultez la section Configurer les journaux d'audit pour l'accès aux données. Pour en savoir plus sur les journaux d'audit dans l'API Cloud Healthcare, consultez la page Afficher Cloud Audit Logs.

Pour en savoir plus sur les journaux d'audit de l'API Consent Management, consultez la section Afficher Cloud Audit Logs.

Créer et gérer des magasins d'autorisations

Configurer les autorisations

Créer un magasin d'autorisations

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Réponse

REST

curl

PowerShell

API Explorer

Réponse

Node.js

Python

Modifier un datastore d'autorisations

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Réponse

REST

curl

PowerShell

API Explorer

Réponse

Node.js

Python

Obtenir des informations sur un magasin d'autorisations

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

Réponse

REST

curl

PowerShell

API Explorer

Réponse

Node.js

Python

Répertorier les magasins d'autorisations dans un ensemble de données

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl

PowerShell

API Explorer

Réponse

Node.js

Python

Supprimer un magasin d'autorisations

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl

PowerShell

API Explorer

Réponse

Node.js

Python

Journaux d'audit