S'authentifier auprès de Data Catalog

Ce document explique comment s'authentifier auprès de Data Catalog de manière automatisée. La façon dont vous vous authentifiez auprès de Data Catalog dépend de l'interface que vous utilisez pour accéder à l'API et de l'environnement dans lequel votre code s'exécute.

Pour en savoir plus sur l'authentification Google Cloud, consultez la page Présentation de l'authentification.

Accès API

Data Catalog est compatible avec l'accès automatisé. Vous pouvez accéder à l'API des manières suivantes :

Bibliothèques clientes

Les bibliothèques clientes Data Catalog offrent une compatibilité de langage de haut niveau avec l'authentification programmatique auprès de Data Catalog. Pour authentifier les appels aux API Google Cloud, les bibliothèques clientes sont compatibles avec les ADC (Identifiants par défaut de l'application). Les bibliothèques recherchent des identifiants dans un ensemble d'emplacements définis et les utilisent pour authentifier les requêtes adressées à l'API. Le service ADC vous permet de mettre des identifiants à disposition de votre application dans divers environnements, tels que l'environnement de développement local ou l'environnement de production, sans avoir à modifier le code de votre application.

Google Cloud CLI

Lorsque vous utilisez gcloud CLI pour accéder à Data Catalog, connectez-vous à gcloud CLI avec un compte utilisateur, qui fournit les identifiants utilisés par les commandes gcloud CLI.

Si les règles de sécurité de votre organisation empêchent les comptes utilisateur de disposer des autorisations requises, vous pouvez utiliser l'emprunt d'identité du compte de service.

Pour en savoir plus, consultez la section S'authentifier pour utiliser gcloud CLI. Pour en savoir plus sur l'utilisation de gcloud CLI avec Data Catalog, consultez la documentation de référence de gcloud CLI.

REST

Vous pouvez vous authentifier auprès de l'API Data Catalog à l'aide de vos identifiants gcloud CLI ou en utilisant les identifiants par défaut de l'application. Pour en savoir plus sur l'authentification pour les requêtes REST, consultez la page S'authentifier pour utiliser REST. Pour en savoir plus sur les types d'identifiants, consultez la section Identifiants gcloud CLI et identifiants ADC.

Configurer l'authentification pour Data Catalog

La façon dont vous configurez l'authentification dépend de l'environnement dans lequel votre code s'exécute.

Les options de configuration d'authentification suivantes sont les plus couramment utilisées. Pour accéder à davantage d'options et pour en savoir plus sur l'authentification, consultez la section Méthodes d'authentification.

Pour un environnement de développement local

Vous pouvez configurer les identifiants pour un environnement de développement local comme suit :

Bibliothèques clientes ou outils tiers

Configurez les identifiants par défaut de l'application dans votre environnement local :

  1. Install the Google Cloud CLI, then initialize it by running the following command: 

    gcloud init

  2. If you're using a local shell, then create local authentication credentials for your user account: 

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

    Un écran de connexion s'affiche. Une fois que vous êtes connecté, vos identifiants sont stockés dans le fichier d'identifiants local utilisé par ADC.

Pour en savoir plus sur l'utilisation des ADC dans un environnement local, consultez la section Configurer l'ADC pour un environnement de développement local.

Requêtes REST à partir de la ligne de commande

Lorsque vous effectuez une requête REST à partir de la ligne de commande, vous pouvez utiliser vos identifiants gcloud CLI en incluant gcloud auth print-access-token dans la commande qui envoie la requête.

L'exemple suivant répertorie les comptes de service du projet spécifié. Vous pouvez utiliser le même modèle pour n'importe quelle requête REST.

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

  • PROJECT_ID : ID de votre projet Google Cloud.

Pour envoyer votre requête, développez l'une des options suivantes :

 

Pour en savoir plus sur l'authentification à l'aide de REST et gRPC, consultez la page S'authentifier pour utiliser REST. Pour en savoir plus sur la différence entre vos identifiants ADC locaux et vos identifiants gcloud CLI, consultez la section Configuration de l'authentification gcloud CLI et configuration ADC.

Emprunter l'identité d'un compte de service

Dans la plupart des cas, vous pouvez vous authentifier à partir d'un environnement de développement local à l'aide de vos identifiants utilisateur. Si cela n'est pas possible ou si vous devez tester les autorisations attribuées à un compte de service, vous pouvez emprunter l'identité d'un compte de service. Vous devez disposer de l'autorisation iam.serviceAccounts.getAccessToken, qui est incluse dans le rôle IAM Créateur de jetons du compte de service (roles/iam.serviceAccountTokenCreator).

Vous pouvez configurer gcloud CLI afin qu'elle utilise l'emprunt d'identité d'un compte de service à l'aide de la commande gcloud config set : 

gcloud config set auth/impersonate_service_account SERVICE_ACCT_EMAIL

Pour certains langages, vous pouvez emprunter l'identité d'un compte de service pour créer un fichier ADC local destiné aux bibliothèques clientes. Cette approche n'est compatible qu'avec les bibliothèques clientes Go, Java, Node.js et Python. Elle n'est pas compatible avec les autres langages. Pour configurer un fichier ADC local avec l'emprunt d'identité d'un compte de service, utilisez l'option --impersonate-service-account avec la commande gcloud auth application-default login : 

gcloud auth application-default login --impersonate-service-account=SERVICE_ACCT_EMAIL

Pour plus d'informations sur l'emprunt de l'identité d'un compte de service, consultez la page Emprunter l'identité d'un compte de service.

Sur Google Cloud

Pour authentifier une charge de travail exécutée sur Google Cloud, vous devez utiliser les identifiants du compte de service associé à la ressource de calcul où votre code est exécuté, par exemple une instance de machine virtuelle (VM) Compute Engine. Cette approche est la méthode d'authentification recommandée pour le code exécuté sur une ressource de calcul Google Cloud.

Pour la plupart des services, vous devez associer le compte de service lorsque vous créez la ressource qui exécutera votre code. Vous ne pourrez pas ajouter ni remplacer le compte de service ultérieurement. Compute Engine fait exception, car il vous permet d'associer un compte de service à une instance de VM à tout moment.

Créez un compte de service à l'aide de la gcloud CLI et associez-le à votre ressource :

  1. Install the Google Cloud CLI, then initialize it by running the following command: 

    gcloud init

  2. Set up authentication:

    1. Create the service account: 

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Replace SERVICE_ACCOUNT_NAME with a name for the service account.

    2. To provide access to your project and your resources, grant a role to the service account: 

      gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE

      Replace the following:

      • SERVICE_ACCOUNT_NAME: the name of the service account
      • PROJECT_ID: the project ID where you created the service account
      • ROLE: the role to grant
    3. To grant another role to the service account, run the command as you did in the previous step.

    4. Grant the required role to the principal that will attach the service account to other resources. 

      gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com --member="user:USER_EMAIL" --role=roles/iam.serviceAccountUser

      Replace the following:

      • SERVICE_ACCOUNT_NAME: the name of the service account
      • PROJECT_ID: the project ID where you created the service account
      • USER_EMAIL: the email address for a Google Account

  3. Créez la ressource qui exécutera votre code et associez-lui le compte de service. Par exemple, si vous utilisez Compute Engine :

    Create a Compute Engine instance. Configure the instance as follows:
    • Remplacez INSTANCE_NAME par le nom d'instance de votre choix.
    • Définissez l'indicateur --zone sur la zone dans laquelle vous souhaitez créer votre instance.
    • Définissez l'option --service-account sur l'adresse e-mail du compte de service que vous avez créé. 
      • gcloud compute instances create INSTANCE_NAME --zone=ZONE --service-account=SERVICE_ACCOUNT_EMAIL

Pour en savoir plus sur l'authentification auprès des API Google, consultez la page Méthodes d'authentification.

Sur site ou chez un autre fournisseur cloud

La méthode recommandée pour configurer l'authentification en dehors de Google Cloud consiste à utiliser la fédération d'identité de charge de travail. Pour en savoir plus, consultez la section Configurer l'ADC pour un fournisseur sur site ou un autre fournisseur cloud dans la documentation sur l'authentification.

Contrôle des accès pour Data Catalog

Après vous être authentifié auprès de Data Catalog, vous devez être autorisé à accéder aux ressources Google Cloud. Data Catalog utilise Identity and Access Management (IAM) pour l'autorisation.

Pour en savoir plus sur les rôles pour Data Catalog, consultez la page Contrôle des accès avec IAM. Pour en savoir plus sur IAM et les autorisations, consultez la section Présentation d'IAM.

Étapes suivantes