Utiliser apigee-ssoadminapi.sh

Edge pour Private Cloud v4.18.01

Le module d'authentification unique Edge accepte deux types de comptes :

  • administrator
  • utilisateur machine

L'utilitaire apigee-ssoadminapi.sh vous permet de gérer les administrateurs et les utilisateurs de machines associés au module SSO Edge.

Utilisez l'utilitaire apigee-ssoadminapi.sh pour :

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

À propos des administrateurs

Un compte administrateur sur le module d'authentification unique Edge est nécessaire pour gérer les propriétés du module. Vous avez également besoin d'identifiants de compte administrateur pour configurer l'API BaaS ou le portail afin de vous connecter au module.

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

  • nom d'utilisateur : défini par la propriété SSO_ADMIN_NAME dans le fichier de configuration utilisé pour configurer le module d'authentification unique Edge. La valeur par défaut est ssoadmin.
  • password: défini par la propriété SSO_ADMIN_SECRET dans le de configuration utilisé pour configurer le module Edge SSO.

À propos des utilisateurs machine

Un utilisateur de machine peut obtenir des jetons OAuth2 sans avoir à spécifier de code secret. Cela signifie que vous pouvez entièrement automatiser le processus d'obtention et d'actualisation des jetons OAuth2 à l'aide de l'API de gestion Edge.

Les utilisateurs machine sont généralement utilisés pour:

  • Configurer le portail des services de développement pour communiquer avec Edge
  • Lorsque l'environnement de développement permet d'automatiser des tâches de développement courantes, telles que les tâches de ou l'intégration continue/le déploiement continu (CI/CD).

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

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 Edge SSO. Généralement, vous installez Utilitaire apigee-ssoadminapi.sh lorsque vous installez le module Edge 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 la section Installer l'utilitaire apigee-setup Edge.
  2. Installez l'utilitaire apigee-ssoadminapi.sh qui permet de gérer les utilisateurs administrateur et machine pour le module Edge SSO :
    >
    /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.

Affichage des informations d'aide apigee-ssoadminapi.sh

Les commandes disponibles pour l'utilitaire sont les suivantes :

  • ajout par l'administrateur
  • suppression par l'administrateur
  • liste des administrateurs
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • liste machineuser 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" à chaque commande pour afficher les informations d'utilisation. Par exemple, exécutez 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 en tant qu'arguments de ligne de commande, ou en mode interactif en répondant à des invites.

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

> 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, comme le mot de passe administrateur, vous êtes invité à les fournir.

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é à fournir 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