Enable an external IDP on the Edge UI

After installing the Apigee SSO module, you must configure the Edge UI to support your external IDP.

After you enable an external IDP on the Edge UI, the Edge UI uses OAuth to connect to the Management Server. You do not have to worry about expiring OAuth tokens between the Edge UI and the Edge Management Server. Expired tokens are automatically refreshed.

You must create a configuration file to set up the Edge UI:


# Comma separated list of URLs for the Edge UI,
# in the format:  http_or_https://IP_or_hostname_of_UI:9000.
# You can have multiple URLs when you have multiple installations
# of the Edge UI or you have multiple data centers.

# Publicly accessible URLs for Edge UI.

# Required variables
# Default is "n" to disable external IDP support.

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

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

# If set, the existing EDGEUI client is deleted and new one is created.
# The default value is "n".
# Set to "y" when you configure your external IDP and change the value of
# any of the EDGEUI_* properties.

To configure the Edge UI to enable support for your external IDP:

  1. Execute the following command:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile

    For Classic UI, use the edge-ui component rather than edge-management-ui.

To later change these values, update the configuration file and execute the command again.