Utilisation des API et des utilitaires d'administration Edge après l'activation de SAML

Edge for Private Cloud v4.19.01

Cette section explique comment exécuter les outils et les commandes d'administration du système Edge après avoir activé SAML. De nombreuses tâches sur Edge nécessitent des identifiants d'administration système, par exemple :

  • Créer des organisations et des environnements
  • Ajouter et supprimer des composants Edge
  • Exécuter des commandes apigee-adminapi.sh

Toutefois, après avoir activé SAML sur Edge, vous désactivez généralement l'authentification de base, de sorte que le seul moyen de s'authentifier est d'utiliser le fournisseur d'identité SAML. Par conséquent, vous devez vous assurer que vous avez ajouté le compte d'administrateur système à votre IdP SAML.

Appeler les API de gestion Edge en tant qu'administrateur système

De nombreux appels d'API Edge nécessitent de transmettre des identifiants d'administrateur système. La page Utiliser SAML avec l'API de gestion Edge contient des instructions sur l'obtention et l'actualisation des jetons lors des appels d'API de gestion Edge.

Utiliser l'utilitaire apigee-adminapi.sh avec l'authentification SAML

Utilisez l'utilitaire apigee-adminapi.sh pour effectuer les mêmes tâches de configuration Edge que celles que vous effectuez en appelant l'API de gestion Edge. L'utilitaire apigee-adminapi.sh présente les avantages suivants :

  • Utiliser une interface de ligne de commande simple
  • Implémente la complétion des commandes par tabulation
  • Fournit des informations d'aide et d'utilisation
  • Peut afficher l'appel d'API correspondant si vous décidez d'essayer l'API

Pour en savoir plus, consultez Utiliser apigee-ssoadminapi.sh.

Après avoir activé l'authentification SAML, vous disposez de plusieurs moyens de transmettre les identifiants de l'administrateur système à l'utilitaire apigee-adminapi.sh.

Vous pouvez afficher toutes les options de n'importe quelle commande apigee-adminapi.sh, y compris les options permettant de spécifier des identifiants SAML, en utilisant l'option "-h" de la commande. Exemple :

apigee-adminapi.sh orgs list -h

Par exemple, vous pouvez transmettre les identifiants de l'administrateur système :

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow password_grant \
  --admin adminEmail --oauth-password adminPword

Où :

  • L'option sso-url spécifie l'URL du module d'authentification unique Edge. Modifiez le port ou le protocole si vous les avez modifiés par rapport à 9099 et HTTP.
  • oauth-flow spécifie passcode ou password_grant. Dans cet exemple, vous spécifiez password_grant.
  • adminEmail est l'adresse e-mail de l'administrateur système.
  • oauth-password spécifie le mot de passe de l'administrateur système.

Vous pouvez également utiliser un code secret lorsque vous appelez la commande :

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode \
  --admin adminEmail --oauth-passcode passcode

Où :

  • oauth-flow spécifie passcode.
  • oauth-passcode spécifie le code secret obtenu à partir de http://edge_sso_IP_DNS:9099/passcode..

Enfin, vous pouvez utiliser un jeton lors de l'appel de la commande :

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode \
  --admin adminEmail --oauth-token token

Où :

  • oauth-flow spécifie passcode ou password_grant, selon la façon dont vous avez obtenu le jeton à l'origine. Dans cet exemple, vous spécifiez passcode, car vous avez initialement obtenu le jeton à l'aide de get_token. Consultez la section Utiliser SAML avec l'API de gestion Edge.
  • oauh_token contient le jeton.

Utiliser les utilitaires Edge avec l'authentification SAML

De nombreux utilitaires Edge nécessitent des identifiants d'administrateur système, par exemple :

  • apigee-provision permet de créer des organisations, des environnements et des hôtes virtuels.
  • setup.sh permet d'ajouter des nœuds à un système existant.
  • Tout autre utilitaire dans lequel vous devez spécifier les identifiants de l'administrateur système dans un fichier de configuration

Ces utilitaires prennent en entrée un fichier de configuration qui spécifie les identifiants de l'administrateur système à l'aide des propriétés suivantes :

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

Si vous omettez le mot de passe, vous êtes invité à le saisir.

Après avoir activé SAML, vous utilisez différentes propriétés pour spécifier les identifiants de l'administrateur système. Par exemple, vous pouvez transmettre les identifiants de l'administrateur système :

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=password_grant
OAUTH_ADMIN_PASSWORD=adminPWord

Où :

  • SSO_LOGIN_URL spécifie l'URL du module d'authentification unique Edge. Modifiez le port ou le protocole si vous les avez modifiés par rapport à 9099 et HTTP.
  • OAUTH_FLOW spécifie passcode ou password_grant. Dans cet exemple, vous spécifiez password_grant, car vous transmettez le mot de passe de l'administrateur système.
  • OAUTH_ADMIN_PASSWORD spécifie le mot de passe de l'administrateur système.

Vous pouvez également utiliser les propriétés suivantes pour spécifier les identifiants dans le cadre d'un flux de code secret :

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_ADMIN_PASSCODE=passcode

Où :

  • OAUTH_FLOW spécifie passcode.
  • OAUTH_ADMIN_PASSCODE spécifie le code secret obtenu à partir de http://edge_sso_IP_DNS:9099/passcode..

Enfin, vous pouvez utiliser un jeton

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_BEARER_TOKEN=token

Où :

  • OAUTH_FLOW spécifie passcode ou password_grant, selon la façon dont vous avez obtenu le jeton à l'origine. Dans cet exemple, vous spécifiez passcode, car vous avez initialement obtenu le jeton à l'aide de get_token. Consultez la section Utiliser SAML avec l'API de gestion Edge.
  • OAUTH_BEARER_TOKEN contient le jeton.