Utiliser apigee-ssoadminapi.sh

Edge pour Private Cloud v4.19.01

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

  • administrator
  • utilisateur machine (SAML uniquement)

L'utilitaire apigee-ssoadminapi.sh vous permet de gérer l'administrateur et la machine les utilisateurs associés au module Edge SSO.

Utilisez l'utilitaire apigee-ssoadminapi.sh pour:

  • 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 Edge SSO est nécessaire pour gérer les propriétés du de ce module.

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

  • username: défini par la propriété SSO_ADMIN_NAME dans le de configuration utilisé pour configurer le module Edge SSO. La valeur par défaut est ssoadmin.
  • mot de passe: 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 peut automatiser complètement le processus d'obtention et d'actualisation des jetons OAuth2 à l'aide de la solution Edge l'API de gestion de projet.

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

  • Configurer le portail Apigee Developer Services (ou simplement le portail ) 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 la section 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 où vous avez installé le module SSO Edge. Généralement, vous installez 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. Ce nœud devrait déjà avoir apigee-service installé comme décrit à l'adresse Installer la configuration Edge d'Apigee utilitaire.
  2. Installer l'utilitaire apigee-ssoadminapi.sh permettant de gérer les administrateurs et les utilisateurs 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 le 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:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Vous trouverez des informations sur ces commandes dans la /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, 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 Edge SSO 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 qui vous invite à 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