Utiliser apigee-ssoadminapi.sh

Le module Apigee SSO accepte deux types de comptes :

L'utilitaire apigee-ssoadminapi.sh vous permet de gérer les comptes utilisateur administrateur et machine associés au module Apigee SSO.

Utilisez l'utilitaire apigee-ssoadminapi.sh pour :

  • Afficher la liste des utilisateurs administrateurs/machines
  • Ajouter ou supprimer des utilisateurs administrateurs/machines
  • Modifier le mot de passe des utilisateurs administrateurs/machines

À propos des utilisateurs disposant du rôle Administrateur

Un compte administrateur sur le module Apigee SSO est requis pour gérer les propriétés du module.

Par défaut, lorsque vous installez le module Apigee SSO, il crée un compte administrateur avec les identifiants suivants :

  • username : défini par la propriété SSO_ADMIN_NAME dans le fichier de configuration utilisé pour configurer le module Apigee SSO. La valeur par défaut est ssoadmin..
  • password : défini par la propriété SSO_ADMIN_SECRET dans le fichier de configuration utilisé pour configurer le module Apigee SSO.

À propos des utilisateurs de machine

Un utilisateur 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 de gestion Edge.

Vous utilisez généralement des utilisateurs de machine pour :

  • Configurer le portail des services pour les développeurs Apigee (ou simplement le portail) pour communiquer avec Edge
  • Lorsque l'environnement de développement prend en charge l'automatisation des tâches de développement courantes, telles que l'automatisation des tests ou l'intégration/livraison continues.

Pour en savoir plus, consultez Automatiser les tâches pour les fournisseurs d'identité externes.

Installer apigee-ssoadminapi.sh

Installez l'utilitaire apigee-ssoadminapi.sh sur le nœud du serveur de gestion Edge sur lequel vous avez installé le module Apigee SSO. En règle générale, vous installez l'utilitaire apigee-ssoadminapi.sh lorsque vous installez le module Apigee SSO.

Si vous n'avez pas encore installé l'utilitaire apigee-ssoadminapi.sh :

  1. Connectez-vous au nœud du serveur de gestion. apigee-service doit déjà être installé sur ce nœud, comme décrit dans Installer l'utilitaire apigee-setup d'Edge.
  2. Installez l'utilitaire apigee-ssoadminapi.sh utilisé pour gérer les utilisateurs administrateurs et les utilisateurs de machines pour le module Apigee SSO en exécutant la commande suivante : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Déconnectez-vous du shell, puis reconnectez-vous pour ajouter l'utilitaire apigee-ssoadminapi.sh à votre chemin d'accès.

Affichez les informations d'aide associées à apigee-ssoadminapi.sh.

Les commandes disponibles pour l'utilitaire sont les suivantes :

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add (utilisez la commande saml pour tous les IdP, y compris LDAP et SAML)
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Vous pouvez consulter les informations sur ces commandes dans le fichier /opt/apigee/apigee-ssoadminapi/README.md. Vous pouvez également spécifier l'option « -h » pour chaque commande afin d'afficher les informations sur l'utilisation.

Par exemple, la commande suivante :

apigee-ssoadminapi.sh admin list -h

Renvoie :

admin list
  --admin SSOADMIN_CLIENT_NAME      Name of the client having administrative privilege on sso
  --secret SSOADMIN_CLIENT_SECRET   Secret/Password for the client
  --host SSO_HOST                   Hostname of SSO server to connect
  --port SSO_PORT                   Port to use during request
  --ssl SSO_URI_SCHEME              Set to https, defaults to http
  --debug                           Set in debug mode, turns on verbose in curl
  -h                                Displays Help

Appeler l'utilitaire apigee-ssoadminapi.sh

Vous pouvez appeler l'utilitaire apigee-ssoadminapi.sh en transmettant toutes les propriétés en tant qu'arguments de ligne de commande, ou en mode interactif en répondant aux invites.

Par exemple, pour spécifier toutes les informations requises sur la ligne de commande afin d'afficher la liste des administrateurs :

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184

Renvoie :

[
  {
    "client_id": "ssoadmin",
    "access_token_validity": 300
  }
]

Si vous omettez des informations requises, telles que le mot de passe administrateur, vous êtes invité à les fournir.

Dans cet exemple, vous omettez les valeurs de --port et --ssl, car le module Apigee SSO utilise les valeurs par défaut 9099 pour --port et http pour --ssl. Si votre installation n'utilise pas ces valeurs par défaut, spécifiez-les :

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123
  --host 35.197.94.184 --port 9443 --ssl https

Vous pouvez également utiliser le formulaire interactif, qui vous invite à saisir toutes les informations :

apigee-ssoadminapi.sh admin list

Vous êtes ensuite invité à fournir toutes les informations requises :

SSO admin name (current): ssoadmin
SSO Admin secret (current):
SSO host: 35.197.94.184