Utiliser apigee-ssoadminapi.sh

Edge for Private Cloud v4.18.01

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

  • administrateur
  • utilisateur de machine

L'utilitaire apigee-ssoadminapi.sh vous permet de gérer les administrateurs et les utilisateurs machine associés au module d'authentification unique Edge.

Utilisez l'utilitaire apigee-ssoadminapi.sh pour:

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

À propos des administrateurs

Un compte administrateur sur le module SSO Edge est requis pour gérer les propriétés du module. Vous avez également besoin d'identifiants de compte administrateur pour configurer l'API BaaS ou du portail pour se connecter au module.

Par défaut, lorsque vous installez le module d'authentification unique Edge, 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 Edge. 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 Edge.

À propos des utilisateurs de la 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 de services pour les développeurs pour communiquer avec Edge
  • Lorsque l'environnement de développement permet l'automatisation pour des tâches de développement courantes, telles que l'automatisation des tests ou l'intégration continue/le déploiement continu (CI/CD).

Pour en savoir plus, consultez la page Utiliser SAML avec les tâches automatisées.

Installer apigee-ssoadminapi.sh

Installez l'utilitaire apigee-ssoadminapi.sh sur le nœud Edge Management Server où vous avez installé le module SSO Edge. En règle générale, vous installez l'utilitaire apigee-ssoadminapi.sh lorsque vous installez le module d'authentification unique Edge.

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 la section Installer l'utilitaire de configuration Edge d'Apigee.
  2. Installez l'utilitaire apigee-ssoadminapi.sh pour gérer les administrateurs et les utilisateurs machine pour le module d'authentification unique Edge:
    >
    /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.

Afficher les informations d'aide relatives à apigee-ssoadminapi.sh

Voici les commandes disponibles pour cet utilitaire:

  • ajout administrateur
  • suppression administrateur
  • liste des administrateurs
  • Définition par l'administrateur du mot de passe
  • ajout de l'utilisateur machine SAML
  • suppression de l'utilisateur de la machine SAML
  • liste des utilisateurs de machines aaml
  • 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 afin d'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 sous forme d'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, procédez comme suit:

> 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 y êtes invité.

Dans cet exemple, vous omettez les valeurs pour --port et --ssl, car le module SSO Edge utilise les valeurs par défaut de 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 ensuite invité à saisir toutes les informations requises:

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