Utiliser OAuth 2.0 pour l'authentification serveur à serveur

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
15 Pour en savoir plus, consultez la page Présentation de l'authentification dans la documentation Google Cloud Platform.

Le système Google OAuth 2.0 prend en charge les interactions de serveur à serveur telles que les interactions entre une application Web et un service Google. Pour ce scénario, vous avez besoin d'un compte de service, qui appartient à votre application et non à un utilisateur final individuel. Votre application appelle les API Google au nom du compte de service. Les utilisateurs ne sont donc pas directement impliqués. Ce scénario est parfois appelé "OAuth en deux étapes" ou "2LO". Le terme associé "OAuth en trois étapes" fait référence aux scénarios dans lesquels votre application appelle les API Google au nom des utilisateurs finaux, et dans lesquels le consentement de l'utilisateur est parfois requis.

En général, une application utilise un compte de service lorsqu'elle utilise les API Google pour utiliser ses propres données plutôt qu'avec les données d'un utilisateur. Par exemple, une application qui utilise Google Cloud Datastore pour la persistance des données utilisera un compte de service pour authentifier ses appels à l'API Google Cloud Datastore.

Les administrateurs de domaine Google Workspace peuvent également accorder au compte de service l'autorité au niveau du domaine pour accéder aux données utilisateur au nom des utilisateurs du domaine.

Ce document explique comment une application peut terminer le flux OAuth 2.0 de serveur à serveur à l'aide d'une bibliothèque cliente des API Google (recommandé) ou de HTTP.

Présentation

Pour permettre les interactions de serveur à serveur, créez d'abord un compte de service pour votre projet dans . Si vous souhaitez accéder aux données utilisateur des utilisateurs de votre compte Google Workspace, déléguez l'accès au compte de service à l'échelle du domaine.

Ensuite, votre application se prépare à effectuer des appels d'API autorisés à l'aide des identifiants du compte de service afin de demander un jeton d'accès au serveur d'authentification OAuth 2.0.

Enfin, votre application peut utiliser le jeton d'accès pour appeler les API Google.

Créer un compte de service

Les identifiants d'un compte de service incluent une adresse e-mail générée, unique et au moins une paire de clés publique/privée. Si la délégation au niveau du domaine est activée, un ID client fait également partie des identifiants du compte de service.

Si votre application s'exécute sur Google App Engine, un compte de service est configuré automatiquement lorsque vous créez votre projet.

Si votre application s'exécute sur Google Compute Engine, un compte de service est également configuré automatiquement lorsque vous créez votre projet. Vous devez toutefois spécifier les champs d'application auxquels votre application doit accéder lorsque vous créez une instance Google Compute Engine. Pour plus d'informations, consultez Préparer une instance pour utiliser des comptes de service.

Si votre application ne s'exécute pas sur Google App Engine ni sur Google Compute Engine, vous devez obtenir ces identifiants dans le fichier . Pour générer les identifiants du compte de service ou afficher les identifiants publics que vous avez déjà générés, procédez comme suit:

Tout d'abord, créez un compte de service :

  1. Ouvrez le Service accounts page.
  2. If prompted, select a project, or create a new one.
  3. Cliquez sur Créer compte de service.
  4. Sous les détails du compte de service, saisissez un nom, ID, et une description pour le compte de service, puis cliquez sur Créer et continuer.
  5. Facultatif: Dans le cadre Accorde compte un service d' accès au projet, sélectionnez les rôles IAM pour accorder au compte de service.
  6. Cliquez sur Continuer.
  7. En option: Les utilisateurs de moins autoriser l' accès à ce compte de service, ajoutez les utilisateurs ou les groupes qui sont autorisés à utiliser et à gérer le compte de service.
  8. Cliquez sur Terminé.
  9. Cliquez sur Créer clé, puis cliquez sur Créer.

Ensuite, créez une clé de compte de service :

  1. Cliquez sur l'adresse e-mail du compte de service que vous avez créé.
  2. Cliquez sur l'onglet Clés.
  3. Dans la liste déroulante touche Ajouter, sélectionnez Créer une nouvelle clé.
  4. Cliquez sur Créer.

Votre nouvelle paire de clés publique/privée est générée et téléchargée sur votre machine ; elle sert de seule copie de la clé privée. Vous êtes responsable de le stocker en toute sécurité. Si vous perdez cette paire de clés, vous devrez en générer une nouvelle.

Vous pouvez revenir au API Console à tout moment pour afficher l'adresse e-mail, les empreintes de clés publiques et d'autres informations, ou pour générer d'autres paires de clés publiques/privées. Pour en savoir plus sur les identifiants du compte de service dans le API Console, consultez la section Comptes de service du fichier d'aide API Console.

Notez l'adresse e-mail du compte de service et stockez le fichier de clé privée du compte de service à un emplacement accessible à votre application. Votre application en a besoin pour effectuer des appels d'API autorisés.

Déléguer l'autorité au niveau du domaine au compte de service

Si vous disposez d'un compte Google Workspace, un administrateur de l'organisation peut autoriser une application à accéder aux données utilisateur pour le compte des utilisateurs du domaine Google Workspace. Par exemple, une application qui ajoute des événements aux agendas de tous les utilisateurs d'un domaine Google Workspace à l'aide de l'API Google Calendar peut utiliser un compte de service pour accéder à l'API Google Agenda au nom des utilisateurs. Le fait d'autoriser un compte de service à accéder aux données pour le compte d'utilisateurs d'un domaine est parfois appelé "délégation de l'autorité au niveau du domaine" à un compte de service.

Pour déléguer l'autorité au niveau du domaine à un compte de service, un super-administrateur du domaine Google Workspace doit procéder comme suit:

  1. Dans la console d'administration de votre domaine Google Workspace, accédez à Menu principal > Sécurité &gt ; Contrôle des accès et des données > Commandes des API.
  2. Dans le volet Délégation au niveau du domaine, sélectionnez Gérer la délégation au niveau du domaine.
  3. Cliquez sur Add New (Ajouter nouveau).
  4. Dans le champ ID client, saisissez l'ID client du compte de service. Vous trouverez l'ID client de votre compte de service dans Service accounts page.
  5. Dans le champ Champs d'application OAuth (délimités par des virgules), saisissez la liste des champs d'application auxquels votre application doit être autorisée à accéder. Par exemple, si votre application a besoin d'un accès complet au niveau du domaine à l'API Google Drive et à l'API Google Calendar, saisissez https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/calendar.
  6. Cliquez sur Autoriser.

Votre application est désormais autorisée à effectuer des appels d'API en tant qu'utilisateurs de votre domaine (pour usurper l'identité d'un utilisateur). Lorsque vous vous préparez à effectuer des appels d'API autorisés, vous spécifiez l'utilisateur dont l'identité doit être empruntée.

Préparation d'un appel d'API autorisé

Java

Après avoir obtenu l'adresse e-mail du client et la clé privée à partir de API Console, utilisez la bibliothèque cliente des API Google pour Java pour créer un objet GoogleCredential à partir des identifiants du compte de service et des champs d'application auxquels votre application doit accéder. Exemple :

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.services.sqladmin.SQLAdminScopes;

// ...

GoogleCredential credential = GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"))
    .createScoped(Collections.singleton(SQLAdminScopes.SQLSERVICE_ADMIN));

Si vous développez une application sur Google Cloud Platform, vous pouvez utiliser les identifiants par défaut de l'application pour simplifier le processus.

Déléguer l'autorité au niveau du domaine

Si vous avez délégué un accès au compte de service à l'échelle du domaine et que vous souhaitez emprunter l'identité d'un compte utilisateur, spécifiez l'adresse e-mail du compte utilisateur avec la méthode createDelegated de l'objet GoogleCredential. Exemple :

GoogleCredential credential = GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"))
    .createScoped(Collections.singleton(SQLAdminScopes.SQLSERVICE_ADMIN))
    .createDelegated("user@example.com");

Utilisez l'objet GoogleCredential pour appeler les API Google dans votre application.

Python

Après avoir obtenu l'adresse e-mail du client et la clé privée à partir de API Console, utilisez la bibliothèque cliente des API Google pour Python pour effectuer les étapes suivantes:

  1. Créez un objet Credentials à partir des identifiants du compte de service et des champs d'application auxquels votre application doit accéder. Exemple :
    from google.oauth2 import service_account
    
    SCOPES = ['https://www.googleapis.com/auth/sqlservice.admin']
    SERVICE_ACCOUNT_FILE = '/path/to/service.json'
    
    credentials = service_account.Credentials.from_service_account_file(
            SERVICE_ACCOUNT_FILE, scopes=SCOPES)

    Si vous développez une application sur Google Cloud Platform, vous pouvez utiliser les identifiants par défaut de l'application pour simplifier le processus.

  2. Déléguer l'autorité au niveau du domaine

    Si vous avez délégué un accès au compte de service à l'échelle du domaine et que vous souhaitez emprunter l'identité d'un compte utilisateur, utilisez la méthode with_subject d'un objet ServiceAccountCredentials existant. Exemple :

    delegated_credentials = credentials.with_subject('user@example.org')

Utilisez l'objet Credentials pour appeler les API Google dans votre application.

HTTP/REST

Une fois que vous avez obtenu l'ID client et la clé privée auprès de API Console, votre application doit effectuer les étapes suivantes:

  1. Créez un jeton Web JSON (JWT, prononcé, &jot&) qui inclut un en-tête, un ensemble de revendications et une signature.
  2. Demandez un jeton d'accès au serveur d'autorisation Google OAuth 2.0.
  3. Gérez la réponse JSON renvoyée par le serveur d'autorisation.

Les sections suivantes expliquent comment effectuer ces étapes.

Si la réponse inclut un jeton d'accès, vous pouvez l'utiliser pour appeler une API Google. (Si la réponse n'inclut pas de jeton d'accès, il est possible que votre JWT et votre jeton ne soient pas correctement formés, ou que le compte de service ne soit pas autorisé à accéder aux champs d'application demandés.)

Lorsque le jeton d'accès expire, votre application génère un autre jeton JWT, le signe et demande un autre jeton d'accès.

Votre application de serveur utilise un jeton JWT pour demander un jeton au serveur d'autorisation de Google, puis utilise ce jeton pour appeler un point de terminaison d'API Google. Aucun utilisateur final n'est impliqué.

Le reste de cette section décrit les spécificités de la création d'un jeton JWT, de sa signature, de la création de la requête de jeton d'accès et de la gestion de la réponse.

Créer un jeton JWT

Un jeton JWT est constitué de trois parties: un en-tête, un ensemble de revendications et une signature. L'en-tête et l'ensemble de revendications sont des objets JSON. Ces objets JSON sont sérialisés au format UTF-8, puis encodés en base64url. Cet encodage offre une résilience en cas de modifications d'encodage dues à des opérations d'encodage répétées. L'en-tête, l'ensemble de revendications et la signature sont concaténés avec un point (.).

Un jeton JWT se compose comme suit:

{Base64url encoded header}.{Base64url encoded claim set}.{Base64url encoded signature}

La chaîne de base de la signature est la suivante:

{Base64url encoded header}.{Base64url encoded claim set}
Former l'en-tête JWT

L'en-tête comprend deux champs qui indiquent l'algorithme de signature et le format de l'assertion. Ces deux champs sont obligatoires, et chaque champ n'a qu'une seule valeur. À mesure que d'autres algorithmes et formats seront ajoutés, cet en-tête changera en conséquence.

Les comptes de service reposent sur l'algorithme RSA SHA-256 et le format de jeton JWT. Par conséquent, la représentation JSON de l'en-tête est la suivante:

{"alg":"RS256","typ":"JWT"}

La représentation en Base64url de ceci est la suivante:

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9
Former l'ensemble de revendications JWT

L'ensemble de revendications JWT contient des informations sur le JWT, y compris les autorisations demandées (portées), la cible du jeton, l'émetteur, l'heure d'émission du jeton et la durée de vie du jeton. La plupart des champs sont obligatoires. Comme l'en-tête JWT, l'ensemble de revendications JWT est un objet JSON et est utilisé dans le calcul de la signature.

Revendications obligatoires

Les revendications requises dans l'ensemble de revendications JWT sont indiquées ci-dessous. Elles peuvent apparaître dans n'importe quel ordre dans l'ensemble de revendications.

Nom Description
iss Adresse e-mail du compte de service.
scope Liste des autorisations demandées par l'application, séparées par un espace.
aud Descripteur de la cible visée par l'assertion. Lorsque vous effectuez une requête de jeton d'accès, cette valeur est toujours https://oauth2.googleapis.com/token.
exp Heure d'expiration de l'assertion, spécifiée en secondes depuis le 1er janvier 1970 à 00:00:00 UTC. Cette valeur est limitée à une heure après l'heure d'émission.
iat Heure à laquelle l'assertion a été émise, spécifiée en secondes depuis le 1er janvier 1970 à minuit (00:00:00 UTC).

La représentation JSON des champs obligatoires dans un ensemble de revendications JWT est présentée ci-dessous:

{
  "iss": "761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com",
  "scope": "https://www.googleapis.com/auth/devstorage.read_only",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}
Revendications supplémentaires

Dans certains cas d'entreprise, une application peut utiliser la délégation au niveau du domaine pour agir au nom d'un utilisateur particulier d'une organisation. L'autorisation d'effectuer ce type d'usurpation d'identité doit être accordée pour qu'une application puisse emprunter l'identité d'un utilisateur. Cette opération est généralement gérée par un super-administrateur. Pour en savoir plus, consultez la page Contrôler l'accès à l'API avec la délégation au niveau du domaine.

Pour obtenir un jeton d'accès qui accorde à une application un accès délégué à une ressource, incluez l'adresse e-mail de l'utilisateur dans la revendication JWT définie comme valeur du champ sub.

Nom Description
sub Adresse e-mail de l'utilisateur pour lequel l'application demande un accès délégué.

Si une application n'est pas autorisée à emprunter l'identité d'un utilisateur, la réponse à une requête de jeton d'accès incluant le champ sub sera une erreur.

Vous trouverez ci-dessous un exemple d'ensemble de revendications JWT incluant le champ sub:

{
  "iss": "761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com",
  "sub": "some.user@example.com",
  "scope": "https://www.googleapis.com/auth/prediction",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}
Encodage de l'ensemble de revendications JWT

Comme pour l'en-tête JWT, l'ensemble de revendications JWT doit être sérialisé en UTF-8 et encodé en base64url-safe. Vous trouverez ci-dessous un exemple de représentation JSON d'un ensemble de revendications JWT:

{
  "iss": "761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com",
  "scope": "https://www.googleapis.com/auth/prediction",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}
Calculer la signature

La signature Web JSON (JWS) est la spécification qui guide la mécanique de génération de la signature pour le JWT. L'entrée de la signature correspond au tableau d'octets du contenu suivant:

{Base64url encoded header}.{Base64url encoded claim set}

L'algorithme de signature de l'en-tête JWT doit être utilisé lors du calcul de la signature. Le seul algorithme de signature accepté par le serveur d'autorisation Google OAuth 2.0 est RSA à l'aide de l'algorithme de hachage SHA-256. Cette valeur est exprimée sous la forme RS256 dans le champ alg de l'en-tête JWT.

Signez la représentation UTF-8 de l'entrée avec SHA256withRSA (également appelé RSASSA-PKCS1-V1_5-SIGN avec la fonction de hachage SHA-256) à l'aide de la clé privée obtenue à partir de Google API Console. Le résultat est un tableau d'octets.

La signature doit ensuite être encodée en base64url. L'en-tête, l'ensemble de revendications et la signature sont concaténés avec un point (.). Le résultat est le JWT. Il doit s'agir des éléments suivants (sauts de ligne ajoutés pour plus de clarté):

{Base64url encoded header}.
{Base64url encoded claim set}.
{Base64url encoded signature}

Voici un exemple de jeton JWT avant l'encodage Base64url:

{"alg":"RS256","typ":"JWT"}.
{
"iss":"761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com",
"scope":"https://www.googleapis.com/auth/prediction",
"aud":"https://oauth2.googleapis.com/token",
"exp":1328554385,
"iat":1328550785
}.
[signature bytes]

Vous trouverez ci-dessous un exemple de jeton JWT signé et prêt à être transmis:

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL29hdXRoMi92NC90b2tlbiIsImV4cCI6MTMyODU1NDM4NSwiaWF0IjoxMzI4NTUwNzg1fQ.UFUt59SUM2_AW4cRU8Y0BYVQsNTo4n7AFsNrqOpYiICDu37vVt-tw38UKzjmUKtcRsLLjrR3gFW3dNDMx_pL9DVjgVHDdYirtrCekUHOYoa1CMR66nxep5q5cBQ4y4u2kIgSvChCTc9pmLLNoIem-ruCecAJYgI9Ks7pTnW1gkOKs0x3YpiLpzplVHAkkHztaXiJdtpBcY1OXyo6jTQCa3Lk2Q3va1dPkh_d--GU2M5flgd8xNBPYw4vxyt0mP59XZlHMpztZt0soSgObf7G3GXArreF_6tpbFsS3z2t5zkEiHuWJXpzcYr5zWTRPDEHsejeBSG8EgpLDce2380ROQ

Envoyer la requête de jeton d'accès

Une fois le jeton JWT signé, il peut être utilisé par une application pour demander un jeton d'accès. Cette requête de jeton d'accès est une requête HTTPS POST, et le corps est encodé au format URL. L'URL est indiquée ci-dessous:

https://oauth2.googleapis.com/token

Les paramètres suivants sont requis dans la requête HTTPS POST:

Nom Description
grant_type Utilisez la chaîne suivante, encodée en URL si nécessaire : urn:ietf:params:oauth:grant-type:jwt-bearer
assertion JWT, y compris la signature.

Vous trouverez ci-dessous un vidage brut de la requête HTTPS POST utilisée dans une requête de jeton d'accès:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vYWNjb3VudHMuZ29vZ2xlLmNvbS9vL29hdXRoMi90b2tlbiIsImV4cCI6MTMyODU3MzM4MSwiaWF0IjoxMzI4NTY5NzgxfQ.ixOUGehweEVX_UKXv5BbbwVEdcz6AYS-6uQV6fGorGKrHf3LIJnyREw9evE-gs2bmMaQI5_UbabvI4k-mQE4kBqtmSpTzxYBL1TCd7Kv5nTZoUC1CmwmWCFqT9RE6D7XSgPUh_jF1qskLa2w0rxMSjwruNKbysgRNctZPln7cqQ

Voici la même requête avec curl :

curl -d 'grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vYWNjb3VudHMuZ29vZ2xlLmNvbS9vL29hdXRoMi90b2tlbiIsImV4cCI6MTMyODU3MzM4MSwiaWF0IjoxMzI4NTY5NzgxfQ.RZVpzWygMLuL-n3GwjW1_yhQhrqDacyvaXkuf8HcJl8EtXYjGjMaW5oiM5cgAaIorrqgYlp4DPF_GuncFqg9uDZrx7pMmCZ_yHfxhSCXru3gbXrZvAIicNQZMFxrEEn4REVuq7DjkTMyCMGCY1dpMa8aWfTQFt3Eh7smLchaZsU
' https://oauth2.googleapis.com/token

Traiter la réponse

Si le JWT et le jeton d'accès sont correctement formés, et que le compte de service est autorisé à effectuer l'opération, la réponse JSON du serveur d'autorisation inclut un jeton d'accès. Voici un exemple de réponse:

{
  "access_token": "1/8xbJqaOZXSUZbHLl5EOtu1pxz3fmmetKx9W8CV4t79M",
  "scope": "https://www.googleapis.com/auth/prediction"
  "token_type": "Bearer",
  "expires_in": 3600
}

Les jetons d'accès peuvent être réutilisés pendant l'intervalle de temps spécifié par la valeur expires_in.

Appeler les API Google

Java

Utilisez l'objet GoogleCredential pour appeler les API Google en procédant comme suit:

  1. Créez un objet de service pour l'API que vous souhaitez appeler à l'aide de l'objet GoogleCredential. Exemple :
    SQLAdmin sqladmin =
        new SQLAdmin.Builder(httpTransport, JSON_FACTORY, credential).build();
  2. Envoyez des requêtes au service d'API à l'aide de l'interface fournie par l'objet de service. Par exemple, vous pouvez lister les instances de bases de données Cloud SQL dans le projet excitant "example-123" :
    SQLAdmin.Instances.List instances =
        sqladmin.instances().list("exciting-example-123").execute();

Python

Utilisez l'objet Credentials autorisé pour appeler les API Google en procédant comme suit:

  1. Créez un objet de service pour l'API que vous souhaitez appeler. Pour créer un objet de service, appelez la fonction build avec le nom et la version de l'API ainsi que l'objet Credentials autorisé. Par exemple, pour appeler la version 1beta3 de l'API Cloud SQL Administration :
    import googleapiclient.discovery
    
    sqladmin = googleapiclient.discovery.build('sqladmin', 'v1beta3', credentials=credentials)
  2. Envoyez des requêtes au service d'API à l'aide de l'interface fournie par l'objet de service. Par exemple, vous pouvez lister les instances de bases de données Cloud SQL dans le projet excitant"example-123" :
    response = sqladmin.instances().list(project='exciting-example-123').execute()

HTTP/REST

Une fois que votre application a obtenu un jeton d'accès, vous pouvez l'utiliser pour appeler une API Google au nom d'un compte de service ou d'un compte utilisateur donné, si le ou les niveaux d'accès requis par l'API ont été accordés. Pour ce faire, incluez le jeton d'accès dans une requête adressée à l'API en incluant un paramètre de requête access_token ou une valeur Bearer d'en-tête HTTP Authorization. Dans la mesure du possible, il est préférable d'utiliser l'en-tête HTTP, car les chaînes de requête ont tendance à être visibles dans les journaux du serveur. Dans la plupart des cas, vous pouvez utiliser une bibliothèque cliente pour configurer vos appels vers les API Google (par exemple, lorsque vous appelez l'API Drive Files).

Vous pouvez essayer toutes les API Google et afficher leur portée sur OAuth 2.0 Playground.

Exemples HTTP GET

Un appel vers le point de terminaison drive.files (l'API Drive Files) à l'aide de l'en-tête HTTP Authorization: Bearer peut ressembler à ceci. Notez que vous devez spécifier votre propre jeton d'accès:

GET /drive/v2/files HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

Voici un appel vers la même API pour l'utilisateur authentifié utilisant le paramètre de chaîne de requête access_token:

GET https://www.googleapis.com/drive/v2/files?access_token=access_token

Exemples curl

Vous pouvez tester ces commandes avec l'application de ligne de commande curl. Voici un exemple qui utilise l'option d'en-tête HTTP (recommandé):

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files

Vous pouvez également utiliser l'option de paramètre de chaîne de requête:

curl https://www.googleapis.com/drive/v2/files?access_token=access_token

Lorsque les jetons d'accès expirent

Les jetons d'accès émis par le serveur d'autorisation Google OAuth 2.0 expirent après la durée indiquée par la valeur expires_in. Lorsqu'un jeton d'accès expire, l'application doit générer un autre jeton JWT, le signer et demander un autre jeton.

Codes d'erreur JWT

Champ error Champ error_description Signification Résolution
unauthorized_client Unauthorized client or scope in request. Si vous essayez d'utiliser la délégation au niveau du domaine, le compte de service n'est pas autorisé dans la console d'administration du domaine de l'utilisateur.

Assurez-vous que le compte de service est autorisé sur la page Délégation au niveau du domaine de la console d'administration pour l'utilisateur dans la revendication sub (champ).

Bien que cela prenne généralement quelques minutes, la propagation de l'autorisation à tous les utilisateurs de votre compte Google peut prendre jusqu'à 24 heures.

unauthorized_client Client is unauthorized to retrieve access tokens using this method, or client not authorized for any of the scopes requested. Un compte de service a été autorisé à l'aide de l'adresse e-mail du client plutôt que de l'ID client (numérique) dans la console d'administration. Sur la page Délégation au niveau du domaine de la console d'administration, supprimez le client, puis ajoutez-le à nouveau avec l'ID numérique.
access_denied (toute valeur) Si vous utilisez la délégation au niveau du domaine, un ou plusieurs champs d'application demandés ne sont pas autorisés dans la console d'administration.

Assurez-vous que le compte de service est autorisé sur la page Délégation au niveau du domaine de la console d'administration pour l'utilisateur dans la revendication sub (champ) et qu'il inclut tous les champs d'application que vous demandez dans la revendication scope de votre jeton JWT.

Bien que cela prenne généralement quelques minutes, la propagation de l'autorisation à tous les utilisateurs de votre compte Google peut prendre jusqu'à 24 heures.

invalid_grant Not a valid email. L'utilisateur n'existe pas. Vérifiez que l'adresse e-mail indiquée dans le champ sub est correcte.
invalid_grant

Invalid JWT: Token must be a short-lived token (60 minutes) and in a reasonable timeframe. Check your 'iat' and 'exp' values and use a clock with skew to account for clock differences between systems.

Cela signifie généralement que l'heure du système local n'est pas correcte. Cela peut également se produire si la valeur exp est postérieure de plus de 65 minutes à la valeur iat ou si la valeur exp est inférieure à la valeur iat.

Assurez-vous que l'horloge du système sur lequel le jeton JWT est généré est correcte. Si nécessaire, synchronisez votre temps avec Google NTP.

invalid_grant Invalid JWT Signature.

L'assertion JWT est signée avec une clé privée non associée au compte de service identifié par l'adresse e-mail du client, ou la clé utilisée a été supprimée, désactivée ou a expiré.

Il est également possible que l'assertion JWT ne soit pas encodée correctement. Elle doit être encodée en base64, sans retour à la ligne ni de remplissage égal aux signes de remplissage.

Décodez l'ensemble de revendications JWT et vérifiez que la clé qui a signé l'assertion est associée au compte de service.

Essayez d'utiliser une bibliothèque OAuth fournie par Google pour vous assurer que le jeton JWT est généré correctement.

invalid_scope Invalid OAuth scope or ID token audience provided. Aucun niveau d'accès n'a été demandé (liste vide), ou l'un des champs d'application demandés n'existe pas (c'est-à-dire non valide).

Assurez-vous que la revendication scope (champ) du JWT est renseignée, puis comparez les champs d'application qu'elle contient avec les champs d'application documentés des API que vous souhaitez utiliser, afin de vérifier qu'il n'y a pas d'erreurs ni de fautes de frappe.

Notez que la liste des champs d'application dans la revendication scope doit être séparée par des espaces, et non par des virgules.

disabled_client The OAuth client was disabled. La clé utilisée pour signer l'assertion JWT est désactivée.

Accédez à Google API Console, puis sous IAM &amp & Admin Accounts (Comptes de service et administration), activez le compte de service qui contient l'&ID de clé utilisé pour signer l'assertion.

Avenant: autorisation de compte de service sans OAuth

Certaines API Google vous permettent d'effectuer des appels d'API autorisés à l'aide d'un jeton JWT signé directement en tant que jeton de support, plutôt que d'un jeton d'accès OAuth 2.0. Lorsque cela est possible, vous pouvez éviter d'avoir à envoyer une requête réseau au serveur d'autorisation de Google avant d'effectuer un appel d'API.

Si l'API que vous souhaitez appeler a une définition de service publiée dans le dépôt GitHub des API Google, vous pouvez effectuer des appels d'API autorisés à l'aide d'un jeton JWT au lieu d'un jeton d'accès. Procédez comme suit :

  1. Créez un compte de service comme décrit ci-dessus. Veillez à conserver le fichier JSON obtenu lorsque vous créez le compte.
  2. À l'aide d'une bibliothèque JWT standard, telle que celle trouvée sur jwt.io, créez un jeton JWT avec un en-tête et une charge utile comme dans l'exemple suivant :
    {
      "alg": "RS256",
      "typ": "JWT",
      "kid": "abcdef1234567890"
    }
    .
    {
      "iss": "123456-compute@developer.gserviceaccount.com",
      "sub": "123456-compute@developer.gserviceaccount.com",
      "aud": "https://firestore.googleapis.com/",
      "iat": 1511900000,
      "exp": 1511903600
    }
    • Dans le champ kid de l'en-tête, spécifiez l'ID de clé privée de votre compte de service. Vous trouverez cette valeur dans le champ private_key_id du fichier JSON de votre compte de service.
    • Pour les champs iss et sub, spécifiez l'adresse e-mail de votre compte de service. Vous trouverez cette valeur dans le champ client_email du fichier JSON de votre compte de service.
    • Dans le champ aud, spécifiez le point de terminaison de l'API. Exemple : https://SERVICE.googleapis.com/.
    • Pour le champ iat, spécifiez l'heure Unix actuelle et pour le champ exp, spécifiez l'heure exactement 3 600 secondes plus tard, lorsque le JWT expirera.

Signez le jeton JWT avec RSA-256 à l'aide de la clé privée située dans le fichier JSON de votre compte de service.

Exemple :

Java

Avec google-api-java-client et java-jwt :

GoogleCredential credential =
        GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"));
PrivateKey privateKey = credential.getServiceAccountPrivateKey();
String privateKeyId = credential.getServiceAccountPrivateKeyId();

long now = System.currentTimeMillis();

try {
    Algorithm algorithm = Algorithm.RSA256(null, privateKey);
    String signedJwt = JWT.create()
        .withKeyId(privateKeyId)
        .withIssuer("123456-compute@developer.gserviceaccount.com")
        .withSubject("123456-compute@developer.gserviceaccount.com")
        .withAudience("https://firestore.googleapis.com/")
        .withIssuedAt(new Date(now))
        .withExpiresAt(new Date(now + 3600 * 1000L))
        .sign(algorithm);
} catch ...

Python

Avec PyJWT :

iat = time.time()
exp = iat + 3600
payload = {'iss': '123456-compute@developer.gserviceaccount.com',
           'sub': '123456-compute@developer.gserviceaccount.com',
           'aud': 'https://firestore.googleapis.com/',
           'iat': iat,
           'exp': exp}
additional_headers = {'kid': PRIVATE_KEY_ID_FROM_JSON}
signed_jwt = jwt.encode(payload, PRIVATE_KEY_FROM_JSON, headers=additional_headers,
                       algorithm='RS256')
  1. Appelez l'API en utilisant le jeton JWT signé comme jeton de support :
    GET /v1/projects/abc/databases/123/indexes HTTP/1.1
    Authorization: Bearer SIGNED_JWT
    Host: firestore.googleapis.com