Utiliser apigee-ssoadminapi.sh

Le module SSO Apigee prend en charge deux types de comptes:

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

Avec l'utilitaire apigee-ssoadminapi.sh:

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

À propos des administrateurs

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

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

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

À 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 faites généralement appel à des utilisateurs 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 permet l'automatisation des tâches de développement courantes, telles que l'automatisation des tests ou l'intégration/la livraison continues.

Pour en savoir plus, consultez Automatiser les tâches pour les IdP externes.

Installer apigee-ssoadminapi.sh

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

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

  1. Connectez-vous au nœud Management Server (Serveur de gestion). apigee-service doit déjà être installé sur ce nœud, comme décrit dans la section Installer l'utilitaire de configuration Edge de Apigee.
  2. Installez l'utilitaire apigee-ssoadminapi.sh permettant de gérer les administrateurs et les utilisateurs machine pour le module SSO Apigee en exécutant la commande suivante : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Déconnectez-vous de l'interface système, puis reconnectez-vous pour ajouter l'utilitaire apigee-ssoadminapi.sh à votre chemin d'accès.

Afficher les informations d'aide concernant le fichier 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 fournisseurs d'identité, y compris LDAP et SAML)
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Vous pouvez afficher des informations sur ces commandes dans le fichier /opt/apigee/apigee-ssoadminapi/README.md. Vous pouvez également spécifier l'option "-h" pour chaque commande pour afficher les informations d'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 pour 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 obligatoires, telles que le mot de passe administrateur, vous êtes invité à le faire.

Dans cet exemple, vous omettez les valeurs pour --port et --ssl, car le module SSO Apigee 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 dans lequel vous êtes invité à saisir toutes les informations:

apigee-ssoadminapi.sh admin list

Vous êtes alors invité à saisir toutes les informations requises:

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