Edge for Private Cloud v4.18.01
Le portail des services pour les développeurs agit en tant que client d'Apigee Edge. Cela signifie que le portail ne fonctionne pas comme un système autonome. En réalité, la plupart des informations utilisées par le portail sont stockées sur Edge. Si nécessaire, le portail envoie une requête pour récupérer des informations depuis Edge ou pour envoyer des informations à Edge.
Le portail est toujours associé à une seule organisation Edge. Lorsque vous configurez le portail, vous pouvez spécifier les identifiants d'authentification de base (nom d'utilisateur et mot de passe) d'un compte de l'organisation que le portail utilise pour communiquer avec Edge.
Si vous choisissez d'activer SAML pour l'authentification Edge, vous pouvez configurer le portail pour qu'il utilise l'authentification SAML lors des requêtes adressées à Edge. La configuration du portail pour utiliser SAML crée automatiquement un compte utilisateur de machine dans l'organisation Edge, que le portail utilise ensuite pour envoyer des requêtes à Edge. Pour en savoir plus sur les utilisateurs de machines, consultez Utiliser SAML avec des tâches automatisées.
La compatibilité SAML pour le portail nécessite que vous ayez déjà installé et configuré le module SSO Edge sur le nœud du serveur de gestion Edge. Le processus général d'activation de SAML pour le portail est le suivant :
- Configurez SAML sur Edge comme décrit dans Installation et configuration de SAML pour Edge. Remarque : L'authentification de base doit toujours être activée sur Edge pour installer le portail. Ne désactivez pas l'authentification de base sur Edge tant que vous n'avez pas configuré le portail pour utiliser SAML.
- Installez le portail et assurez-vous que votre installation fonctionne correctement. Consultez Installer le portail des services de développement Edge pour Private Cloud.
- Configurez SAML sur le portail.
- Vous pouvez désormais désactiver l'authentification de base sur Edge.
Créer un utilisateur machine pour le portail
Lorsque SAML est activé, Edge accepte la génération automatique de jetons OAuth2 via l'utilisation d'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.
Le processus de configuration SAML pour le portail crée automatiquement un utilisateur machine dans l'organisation associée au portail. Le portail utilise ensuite ce compte utilisateur de machine pour se connecter à Edge. Pour en savoir plus sur les utilisateurs de machines, consultez Utiliser SAML avec des tâches automatisées.
À propos de l'authentification pour les comptes de développeur du portail
Lorsque vous configurez le portail pour utiliser SAML, vous l'activez pour qu'il utilise SAML pour s'authentifier auprès d'Edge afin que le portail puisse envoyer des requêtes à Edge. Toutefois, le portail accepte également un type d'utilisateur appelé développeurs.
Les développeurs constituent la communauté d'utilisateurs qui créent des applications à l'aide de vos API. Les développeurs d'applications utilisent le portail pour en savoir plus sur vos API, enregistrer des applications qui les utilisent, interagir avec la communauté de développeurs et afficher des informations statistiques sur l'utilisation de leurs applications sur un tableau de bord.
Lorsqu'un développeur se connecte au portail, c'est le portail qui est chargé de l'authentifier et d'appliquer les autorisations basées sur les rôles. Le portail continue d'utiliser l'authentification de base avec les développeurs, même après l'activation de SAML entre le portail et Edge. Pour en savoir plus, consultez Communication entre le portail et Edge.
Il est également possible de configurer le portail pour qu'il utilise SAML pour authentifier les développeurs. Pour obtenir un exemple d'activation de SAML à l'aide de modules Drupal tiers, consultez la page https://community.apigee.com/articles/29201/sso-integration-via-saml-with-developer-portal.html.
Configurer SAML sur le portail pour communiquer avec Edge
Pour configurer SAML pour le portail, vous devez créer un fichier de configuration pour configurer le portail :
# IP address of Edge Management Server and apigee-sso node. IP1=22.222.22.222 # URL of Edge management API. MGMT_URL=http://$IP1:8080/v1 # Org associated with the portal. EDGE_ORG=myorg # Information about apigee-sso. # Externally accessible IP or DNS of apigee-sso. SSO_PUBLIC_URL_HOSTNAME=$IP1 SSO_PUBLIC_URL_PORT=9099 # Default is http. Set to https if you enabled TLS on apigee-sso. SSO_PUBLIC_URL_SCHEME=http # SSO admin credentials as set when you installed apigee-sso. SSO_ADMIN_NAME=ssoadmin SSO_ADMIN_SECRET=Secret123 # Default is "n" to disable SAML support. DEVPORTAL_SSO_ENABLED=y # The name of the OAuth client used to connect to apigee-sso. # The default client name is portalcli. PORTALCLI_SSO_CLIENT_NAME=portalcli # Oauth client password using uppercase, lowercase, number, and special chars. PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1 # Email address and user info for the machine user created in # the Edge org specified above by EDGE_ORG. # This account is used by the portal to make requests to Edge. # Add this email as an org admin before configuring the portal to use SAML. DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com DEVPORTAL_ADMIN_FIRSTNAME=DevPortal DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin DEVPORTAL_ADMIN_PWD=Abcdefg@1 # If set, the existing portal OAuth client is deleted and new one is created. # The default value is "n". # Set to "y" when you configure SAML and change the value of # any of the PORTALCLI_* properties. PORTALCLI_SSO_CLIENT_OVERWRITE=y
Pour activer la compatibilité avec SAML sur le portail :
- Dans l'interface utilisateur d'Edge, ajoutez l'utilisateur de l'ordinateur spécifié par DEVPORTAL_ADMIN_EMAIL à l'organisation associée au portail en tant qu'administrateur de l'organisation.
Remarque : L'utilisateur machine n'existe pas encore, mais il est créé automatiquement à l'étape suivante. - Exécutez la commande suivante pour configurer SAML sur le portail :
> /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile
où samlConfigFile est le fichier de configuration SAML. - Connectez-vous au portail en tant qu'administrateur du portail.
- Dans le menu principal de Drupal, sélectionnez Configuration > Dev Portal. L'écran de configuration du portail s'affiche, y compris les paramètres SAML :
Notez que la case Cette organisation est compatible avec SAML est cochée, que le point de terminaison du module SSO Edge est renseigné, que les champs Clé API et Code secret du client du client OAuth du portail sont renseignés et que le message Connexion réussie s'affiche sous le bouton Tester la connexion.
- Vous pouvez appuyer sur le bouton Tester la connexion pour tester à nouveau la connexion à tout moment.
Pour modifier ces valeurs ultérieurement, mettez à jour le fichier de configuration et exécutez à nouveau la commande.
Désactiver SAML sur le portail
Si vous choisissez de désactiver SAML pour les communications entre le portail et Edge, le portail ne pourra plus envoyer de requêtes à Edge. Les développeurs peuvent se connecter au portail, mais ne peuvent pas afficher de produits ni créer d'applications.
Attention : Si vous désactivez SAML, vous devez reconfigurer le portail pour qu'il utilise SAML ou, si Edge est toujours configuré pour accepter l'authentification de base, configurer le portail pour qu'il communique avec Edge à l'aide de l'authentification de base. Pour en savoir plus sur l'utilisation de l'authentification de base, consultez Communiquer entre le portail et Edge.
Pour désactiver SAML sur le portail :
- Modifiez le fichier de configuration que vous avez utilisé pour configurer SAM afin de définir :
DEVPORTAL_SSO_ENABLED=n - Configurez le portail :
> /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile