Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
Lorsque vous utilisez SAML avec l'API Edge, le processus permettant d'obtenir des jetons d'accès et d'actualisation OAuth2 à partir de l'assertion SAML est appelé flux de code secret. Avec le flux de code secret , vous utilisez un navigateur pour obtenir un code secret à usage unique, que vous utilisez ensuite pour obtenir des jetons OAuth2.
Toutefois, votre environnement peut être compatible avec l'automatisation des tâches de développement courantes, telles que l'automatisation des tests ou l'intégration/déploiement continus (CI/CD). Pour automatiser ces tâches lorsque SAML est activé, vous devez pouvoir obtenir et actualiser des jetons OAuth2 sans avoir à copier/coller un code secret à partir d'un navigateur.
À propos des utilisateurs de machines
Apigee Edge est compatible avec les utilisateurs de machines dans votre organisation compatible avec SAML. Les utilisateurs de machines sont utilisés strictement pour l'automatisation et ne sont pas accessibles directement par un humain.
Un utilisateur de machine peut obtenir des jetons OAuth2 sans avoir à spécifier de code secret. Cela signifie que vous pouvez automatiser complètement le processus d' obtention et d'actualisation des jetons OAuth2 à l'aide de l'API Edge.
Étapes pour automatiser le processus de génération de jetons
Pour automatiser le processus de génération de jetons :
Vidéo : Regardez une courte vidéo pour découvrir comment automatiser l'accès aux API Apigee Edge à l'aide des identifiants d'utilisateur de machine.
Gérer les utilisateurs de machines pour les zones d'identité SAML
Apigee fournit l'interface de ligne de commande (CLI) de gestion des utilisateurs de machines pour créer et gérer des comptes d'utilisateur de machine. Les étapes à suivre pour utiliser la CLI de gestion des utilisateurs de machines sont décrites dans les sections suivantes.
Utiliser la CLI
Pour utiliser la CLI de gestion des utilisateurs de machines, téléchargez et décompressez d'abord le fichier suivant :
usermgmt.tar.gz(1)
Le format d'appel de la CLI est le suivant :
usermgmt_platform [command] [flags]
Le tableau suivant récapitule les plates-formes compatibles et la commande correspondante pour appeler la CLI de gestion des utilisateurs de machines.
(Les exécutables se trouvent dans le répertoire usermgmt.)
| Plate-forme | 32 bits | 64 bits |
|---|---|---|
| Linux | usermgmt_linux_386 |
usermgmt_linux_amd64 |
| Mac | usermgmt_darwin_386 |
usermgmt_darwin_amd64 |
| Windows | usermgmt_windows_386 |
usermgmt_windows_amd64 |
Le tableau suivant récapitule les commandes qui peuvent être spécifiées.
Vous pouvez également transmettre l'une des options suivantes pour afficher l'aide sur la commande spécifiée : -h ou --help
Se connecter à la CLI
La première fois que vous exécutez la CLI sur une période de 24 heures, vous êtes invité à saisir les identifiants de votre compte zoneadmin.
Enter your Apigee credentials
Username: zoneadmin-username
Password: zoneadmin-password
If your user is opted with MFA, enter MFA code. Otherwise press enter to skip.
MFA: mfa-code_or_enter_to_skipLa CLI de gestion des utilisateurs de machines stocke un jeton d'accès sur votre machine locale. Vous n'avez donc besoin de vous connecter qu'une seule fois par période de 24 heures.
Obtenir de l'aide pour utiliser la CLI
Affichez les informations d'utilisation de la CLI à l'aide de la commande usermgmt_platform help. Pour obtenir la liste des plates-formes compatibles, consultez Utiliser la CLI.
usermgmt_platform help
Les informations d'aide suivantes s'affichent :
A command-line interface (CLI) to manage machine user accounts to automate
Apigee identity zone management. Use the CLI to create, list, delete,
and reset the password for machine users.
Usage:
usermgmt [flags]
usermgmt [command]
Available Commands:
create Creates a machine users in an identity zone.
delete Deletes a machine users in an identity zone.
help Help about any command
list Lists the machine users in an identity zone.
reset Resets the password for a machine user in an identity zone.
Flags:
-h, --help help for usermgmt
Use "usermgmt [command] --help" for more information about a command.
Affichez l'aide sur une commande spécifique en transmettant à la fois la commande et l'option -h ou --help sur la ligne de commande.
Par exemple, pour obtenir de l'aide sur la commande list :
usermgmt_platform list -h
Les informations d'aide suivantes s'affichent :
Lists the machine users in an identity zone.
Usage:
usermgmt list [flags]
Flags:
-h, --help help for list
Créer un utilisateur de machine dans une zone d'identité
Créez un utilisateur de machine dans une zone d'identité à l'aide de la commande usermgmt_platform create. Pour obtenir la liste des plates-formes compatibles, consultez Utiliser la CLI.
- Saisissez la commande suivante :
usermgmt_platform createLa liste des zones d'identité s'affiche :
myzone1 myzone2 - Saisissez le nom d'une zone à l'invite :
Enter a zone name: myzone1 - Saisissez un nom d'utilisateur pour l'utilisateur de machine :
Create a Machine User Username: machineuser1@mycompany.com - Saisissez un mot de passe pour l'utilisateur de machine. Saisissez à nouveau le mot de passe lorsque vous y êtes invité.
Password: password Re-enter password: passwordL'utilisateur est créé.
Created machine user machineuser1@mycompany.com
Répertorier tous les utilisateurs de machines dans une zone d'identité
Répertoriez tous les utilisateurs de machines dans une zone d'identité à l'aide de la commande usermgmt_platform list. Pour obtenir la liste des plates-formes compatibles, consultez Utiliser la CLI.
- Saisissez la commande suivante :
La liste des zones d'identité s'affiche :usermgmt_platform listmyzone1 myzone2 - Saisissez le nom d'une zone à l'invite :
Enter a zone name: myzone1La liste des utilisateurs de machines dans la zone d'identité s'affiche :
Machine users in the zone: machineuser1@mycompany.com
Réinitialiser le mot de passe d'un utilisateur de machine dans une zone d'identité
Réinitialisez le mot de passe d'un utilisateur de machine dans une zone d'identité à l'aide de la commande usermgmt_platform reset. Pour obtenir la liste des plates-formes compatibles, consultez Utiliser la CLI.
- Saisissez la commande suivante :
usermgmt_platform resetLa liste des zones d'identité s'affiche :
myzone1 myzone2 - Saisissez le nom d'une zone à l'invite :
Enter a zone name: myzone1 - Saisissez le nom d'utilisateur de l'utilisateur de machine pour lequel vous souhaitez réinitialiser le mot de passe :
Reset User Password Enter the username for the machine user Username: machineuser1@mycompany.com - Saisissez un nouveau mot de passe pour l'utilisateur de machine. Saisissez à nouveau le mot de passe lorsque vous y êtes invité.
Enter the new password: password Re-enter password: passwordLe mot de passe est réinitialisé.
Reset password for machine user machineuser1@mycompany.com
Supprimer un utilisateur de machine dans une zone d'identité
Supprimez un utilisateur de machine dans une zone d'identité à l'aide de la commande usermgmt_platform delete. Pour obtenir la liste des plates-formes compatibles, consultez Utiliser la CLI.
- Saisissez la commande suivante :
La liste des zones d'identité s'affiche :usermgmt_platform deletemyzone1 myzone2 - Saisissez le nom d'une zone à l'invite :
Enter a zone name: myzone1 - Saisissez le nom d'utilisateur de l'utilisateur de machine que vous souhaitez supprimer :
Delete User Enter the username for the machine user Username: machineuser1@mycompany.comL'utilisateur de machine est supprimé.
Deleted user machineuser1@mycompany.com
Attribuer les rôles requis à l'utilisateur de machine dans votre organisation Edge
À l'aide de l'interface utilisateur, ajoutez l'utilisateur de machine à votre organisation Edge compatible avec SAML et attribuez-lui les rôles requis (tels qu'administrateur de l'organisation), comme décrit dans Ajouter des utilisateurs.
Obtenir les jetons OAuth2 de l'utilisateur de machine
Vous pouvez automatiser le processus de génération de jetons et gérer la mise en cache des jetons pour les utilisateurs de machines avec les
acurl(1) et get_token(1) utilitaires, comme décrit dans
OAuth2 pour les utilisateurs de machines et Utilisateurs de machines dans les zones SAML.
Pour obtenir manuellement les jetons OAuth2 de l'utilisateur de machine avec curl :
- Utilisez l'outil d'encodage d'URL de votre choix pour encoder le nom d'utilisateur et le mot de passe de l'utilisateur de machine.
Avertissement : Utilisez un outil d'encodage d'URL
interne pour vous assurer que les identifiants de l'utilisateur de machine ne seront pas compromis. - Générez les jetons d'accès et d'actualisation initiaux en appelant le point de terminaison de jeton SAML, comme illustré dans l'exemple suivant :
curl -H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" \ -H "accept: application/json;charset=utf-8" \ -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \ https://zoneName.login.apigee.com/oauth/token -s \ -d 'grant_type=password&username=machineusername&password=machineuserpassword'
Pour l'autorisation, transmettez les identifiants client OAuth2 réservés,
ZWRnZWNsaTplZGdlY2xpc2VjcmV0, dans l'Authorizationen-tête. L'appel affiche les jetons d'accès et d'actualisation dansstdout. - Transmettez le jeton d'accès à un appel d'API de gestion Edge en tant qu'en-tête Bearer :
curl -H "Authorization: Bearer ACCESS_TOKEN" \ https://api.enterprise.apigee.com/v1/organizations/orgName
- Lorsque le jeton d'accès expire, vous pouvez l'actualiser en envoyant le jeton d'actualisation au point de terminaison de jeton SAML, comme illustré dans l'exemple suivant :
curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" \ -H "Accept: application/json;charset=utf-8" \ -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \ https://zoneName.login.apigee.com/oauth/token \ -d 'grant_type=refresh_token&refresh_token=REFRESH_TOKEN'
(1) Copyright 2023 Google LLC
Les outils usermgmt, acurl et get_token sont mis à disposition en tant que "Logiciel" en vertu du
contrat régissant votre utilisation de Google Cloud Platform, y compris les Conditions
spécifiques aux services disponibles à l'adresse https://cloud.google.com/terms/service-terms.