Configura el portal para usar IdP externos

El portal de servicios para desarrolladores de Apigee (o simplemente, el portal) actúa como un cliente de Apigee Edge. Esto significa que el portal no funciona como un sistema independiente. En cambio, gran parte de la información que usa el portal se almacena en Edge. Cuando es necesario, el portal realiza una solicitud para recuperar información de Edge o enviar información a Edge.

El portal siempre está asociado con una sola organización de Edge. Cuando configuras el portal, puedes especificar las credenciales de autenticación básica (nombre de usuario y contraseña) para una cuenta de la organización que el portal usa para comunicarse con Edge.

Si eliges habilitar un IDP externo, como SAML o LDAP, para la autenticación de Edge, puedes configurar el portal para que use esa autenticación cuando realice solicitudes a Edge. Si configuras el portal para que use un IDP externo, se creará automáticamente una nueva cuenta de usuario de máquina en la organización de Edge que el portal usará para realizar solicitudes a Edge. Para obtener más información sobre los usuarios de máquinas, consulta Automatiza tareas para IdP externos.

La compatibilidad con el IdP externo para el portal requiere que ya hayas instalado y configurado el módulo de SSO de Apigee en el nodo del servidor de administración de Edge. El proceso general para habilitar un IdP externo en el portal es el siguiente:

  1. Instala el módulo de SSO de Apigee, como se describe en Instala y configura el SSO de Apigee.
  2. Instala el portal y asegúrate de que la instalación funcione correctamente. Consulta Instala el portal.
  3. Configura SAML o LDAP en el portal, como se describe en esta sección.
  4. Inhabilita la autenticación básica en Edge, como se describe en Inhabilita la autenticación básica en Edge (opcional).

Crea un usuario de máquina para el portal

Cuando se habilita un IDP externo, Edge admite la generación automatizada de tokens de OAuth2 mediante el uso de usuarios de máquina. Un usuario de máquina puede obtener tokens de OAuth2 sin tener que especificar una contraseña. Esto significa que puedes automatizar por completo el proceso de obtención y actualización de tokens de OAuth2.

El proceso de configuración del IdP para el portal crea automáticamente un usuario de máquina en la organización asociada con el portal. Luego, el portal usa esta cuenta de usuario de máquina para conectarse a Edge. Para obtener más información sobre los usuarios de máquinas, consulta Automatiza tareas para IdP externos.

Acerca de la autenticación para las cuentas de desarrollador del portal

Cuando configuras el portal para que use un IdP externo, habilitas el portal para que use SAML o LDAP para autenticarse con Edge, de modo que el portal pueda realizar solicitudes a Edge. Sin embargo, el portal también admite un tipo de usuario llamado desarrollador.

Los desarrolladores conforman la comunidad de usuarios que crean apps con tus APIs. Los desarrolladores de apps usan el portal para obtener información sobre tus APIs, registrar apps que las usen, interactuar con la comunidad de desarrolladores y ver información estadística sobre el uso de sus apps en un panel.

Cuando un desarrollador accede al portal, este es responsable de autenticarlo y de aplicar los permisos basados en roles. El portal sigue usando la autenticación básica con los desarrolladores, incluso después de habilitar la autenticación de IdP entre el portal y Edge. Para obtener más información, consulta Comunicación entre el portal y Edge.

También es posible configurar el portal para que use SAML o LDAP para autenticar a los desarrolladores. Para ver un ejemplo de cómo habilitar SAML con módulos de Drupal de terceros, consulta Integración de SSO a través de SAML con el portal para desarrolladores.

Archivo de configuración del IdP para el portal

Para configurar un IdP externo para el portal, debes crear un archivo de configuración que defina los parámetros de configuración del portal.

En el siguiente ejemplo, se muestra un archivo de configuración del portal con compatibilidad con IdP:

# IP address of Edge Management Server and the node on which the Apigee SSO module is installed.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Organization associated with the portal.
EDGE_ORG=myorg

# Information about the Apigee SSO module (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

# Enables or disables external IDP support.
# Default is "n", which disables external IDP support.
# Change it to "y" to enable external IDs support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth2 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 characters.
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 an external IDP.
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 a new one is created.
# The default value is "n".
# Set to "y" when you configure the external IDP and change the value of
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

Para habilitar la compatibilidad con IdP externos en el portal, sigue estos pasos:

  1. En la IU de Edge, agrega el usuario del sistema especificado por DEVPORTAL_ADMIN_EMAIL a la organización asociada con el portal como administrador de la organización.
  2. Ejecuta el siguiente comando para configurar el IdP externo en el portal: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile

    Donde configFile es el archivo de configuración descrito anteriormente.

  3. Accede al portal como administrador.
  4. En el menú principal de Drupal, selecciona Configuration > Dev Portal. Aparecerá la pantalla de configuración del portal, incluida la configuración del IdP externo:

    Ten en cuenta lo siguiente:

    • La casilla Esta organización tiene habilitado SAML está marcada.
    • Se completó el extremo del módulo de SSO de Apigee
    • Se completan los campos Clave de API y Secreto del consumidor del cliente de OAuth del portal.
    • Aparecerá el mensaje Conexión correcta debajo del botón Probar conexión.
  5. Haz clic en el botón Test Connection para volver a probar la conexión en cualquier momento.

Para cambiar estos valores más adelante, actualiza el archivo de configuración y vuelve a ejecutar este procedimiento.

Inhabilita un IdP externo en el portal

Si eliges inhabilitar tu IdP externo para las comunicaciones entre el portal y Edge, el portal ya no podrá realizar solicitudes a Edge. Los desarrolladores pueden acceder al portal, pero no podrán ver el producto ni crear apps.

Para inhabilitar la autenticación de IdP externo en el portal, sigue estos pasos:

  1. Abre el archivo de configuración que usaste antes para habilitar el IdP externo.
  2. Establece el valor de la propiedad DEVPORTAL_SSO_ENABLED en n, como se muestra en el siguiente ejemplo: 
    DEVPORTAL_SSO_ENABLED=n
  3. Ejecuta el siguiente comando para configurar el portal: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile