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

S'authentifier sur Vertex AI Agent Builder

Ce document explique comment s'authentifier auprès de Vertex AI Agent Builder de manière automatisée. La façon dont vous vous authentifiez auprès de Vertex AI Agent Builder 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

Vertex AI Agent Builder est compatible avec l'accès automatisé. Vous pouvez accéder à l'API des manières suivantes :

Bibliothèques clientes
REST

Bibliothèques clientes

Les bibliothèques clientes Vertex AI Agent Builder acceptent un large panel de langages pour définir l'authentification automatisée auprès de Vertex AI Agent Builder. 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.

REST

Vous pouvez vous authentifier auprès de l'API Vertex AI Agent Builder à 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.

Clés API

Les clés API permettent d'associer un appel d'API à un projet, à des fins de facturation et de quota, sans déterminer l'identité de l'appelant. Les clés API ne peuvent être utilisées qu'avec des méthodes d'API compatibles.

Vertex AI Agent Builder accepte les clés API pour les méthodes d'API suivantes:

userEvents.Collect. Pour en savoir plus, consultez Créer une clé API.

servingConfigs.searchLite. Pour en savoir plus, consultez Obtenir les résultats de recherche pour une application avec des données de site Web (clé API).

Pour obtenir des informations générales sur l'utilisation des clés API, consultez la page S'authentifier à l'aide de clés API.

Configurer l'authentification pour Vertex AI Agent Builder

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.

Avant de suivre ces instructions, vous devez avoir effectué la configuration de base de Vertex AI Agent Builder, comme décrit dans la section Avant de commencer.

Pour un environnement de développement local

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

Identifiants utilisateur pour les bibliothèques clientes ou les outils tiers
Identifiants utilisateur pour les requêtes REST depuis la ligne de commande

Bibliothèques clientes ou outils tiers

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

Install the Google Cloud CLI, then initialize it by running the following command:
```
gcloud init
```
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 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 :

curl (Linux, macOS ou Cloud Shell)

Exécutez la commande suivante :

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts"

PowerShell (Windows)

Exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts" | Select-Object -Expand Content

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.

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 :

Install the Google Cloud CLI, then initialize it by running the following command:
```
gcloud init
```
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
  Note: The --role flag affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
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
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éé.

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 Fournisseur sur site ou autre fournisseur cloud dans la documentation sur l'authentification.

Contrôle des accès pour Vertex AI Agent Builder

Une fois que vous êtes authentifié auprès de Vertex AI Agent Builder, vous devez être autorisé à accéder aux ressources Google Cloud. Vertex AI Agent Builder utilise Identity and Access Management (IAM) pour l'autorisation.

Pour en savoir plus sur les rôles pour Vertex AI Agent Builder, 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

Découvrez les méthodes d'authentification de Google Cloud.
Consultez la liste des cas d'utilisation de l'authentification.