Configuring the portal to use SAML to communicate with Edge

Edge for Private Cloud v4.19.01

Apigee Developer Services portal (or simply, the portal) acts as a client of Apigee Edge. That means the portal does not function as a stand-alone system. Instead, much of the information used by the portal is actually stored on Edge. When necessary, the portal makes a request to retrieve information from Edge or to send information to Edge.

The portal is always associated with a single Edge organization. When you configure the portal, you can specify the basic authentication credentials (username and password) for an account in the organization that the portal uses to communicate with Edge.

If you choose to enable SAML for Edge authentication, you can then configure the portal to use SAML authentication when making requests to Edge. Configuring the portal to use SAML automatically creates a new machine user account in the Edge organization that the portal then uses to make requests to Edge. For more on machine users, see Using SAML with automated tasks.

SAML support for the portal requires that you have already installed and configures the Edge SSO module on the Edge Management Server node. The general process for enabling SAML for the portal is:

  1. Configure SAML on Edge as described in Installation and configuration of SAML for Edge. Note: Basic Auth must still be enabled on Edge to install the portal. Do not disable Basic Auth on Edge until after you have configured the portal to use SAML.
  2. Install the portal and ensure that your installation is working properly. See Installing the Edge for Private Cloud portal.
  3. Configure SAML on the portal.
  4. You can now disable Basic Auth on Edge.

Creating a machine user for the portal

When SAML is enabled, Edge supports automated OAuth2 token generation through the use of machine users. A machine user can obtain OAuth2 tokens without having to specify a passcode. That means you can completely automate the process of obtaining and refreshing OAuth2 tokens.

The SAML configuration process for the portal automatically creates a machine user in the organization associated with the portal. The portal then uses this machine user account to connect to Edge. For more on machine users, see Using SAML with automated tasks.

About authentication for portal developer accounts

When you configure the portal to use SAML, you enable the portal to use SAML to authenticate with Edge so that the portal can make requests to Edge. However, the portal also supports a type of user called developers.

Developers make up the community of users that build apps by using your APIs. App developers use the portal to learn about your APIs, to register apps that use your APIs, to interact with the developer community, and to view statistical information about their app usage on a dashboard.

When a developer logs in to the portal, it is the portal that is responsible for authenticating the developer and for enforcing role-based permissions. The portal continues to use basic authentication with developers even after you enable SAML between the portal and Edge. For more, see Communicating between the portal and Edge.

It is possible to also configure the portal to use SAML to authenticate developers. For an example on enabling SAML using third-party Drupal modules, see SSO Integration via SAML with Developer Portal.

Configure SAML on the portal to communicate with Edge

To configure SAML for the portal, you must create a config file to configure the portal:

# IP address of Edge Management Server and apigee-sso node.

# URL of Edge management API.

# Org associated with the portal.

# Information about apigee-sso.
# Externally accessible IP or DNS of apigee-sso.
# Default is http. Set to https if you enabled TLS on apigee-sso.

# SSO admin credentials as set when you installed apigee-sso.

# Default is "n" to disable SAML support.

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is portalcli.
# Oauth client password using uppercase, lowercase, number, and special chars. 

# 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.

# 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.

To enable SAML support on the portal:

  1. In the Edge UI, add the machine user specified by DEVPORTAL_ADMIN_EMAIL to the organization associated with the portal as an Organization Administrator.
  2. Run the following command to configure SAML on the portal:
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    Where samlConfigFile is the SAML config file.

  3. Log in to the portal as a portal admin.
  4. In the main Drupal menu, select Configuration > Dev Portal. The portal configuration screen appears, including the SAML settings:

    Note that the box for This org is SAML-enabled is checked, the endpoint for the Edge SSO module is filled in, the API key and Consumer secret fields for the portal Oauth client are filled in, and the message Connection Successful appears under the Test Connection button.

  5. You can press the Test Connection button to retest the connection at any time.

To later change these values, update the config file and run the command again.

Disable SAML on the portal

If you choose to disable SAML for communications between the portal and Edge, the portal will no longer be able to make requests to Edge. Developers are able to log in to the portal but will not be able to view product or create apps.

To disable SAML on the portal:

  1. Edit the config file that you used to configure SAM to set:
  2. Configure the portal:
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile