Configurazione del portale per l'utilizzo di SAML per comunicare con Edge

Edge for Private Cloud v4.18.05

Il portale Apigee Developer Services (o semplicemente il portale) funge da client di Apigee Edge. Ciò significa che il portale non funziona come sistema autonomo. Tuttavia, gran parte delle informazioni utilizzate dal portale è effettivamente memorizzata su Edge. Se necessario, il portale invia una richiesta per recuperare informazioni da Edge o per inviare informazioni a Edge.

Il portale è sempre associato a una singola organizzazione Edge. Quando configuri il portale, puoi specificare le credenziali di autenticazione di base (nome utente e password) per un account dell'organizzazione utilizzato dal portale per comunicare con Edge.

Se scegli di attivare SAML per l'autenticazione di Edge, puoi configurare il portale in modo che utilizzi l'autenticazione SAML quando invia richieste a Edge. La configurazione del portale per l'utilizzo di SAML crea automaticamente un nuovo account utente della macchina nell'organizzazione Edge, che il portale poi utilizza per inviare richieste a Edge. Per saperne di più sugli utenti macchina, vedi Utilizzare SAML con le attività automatiche.

Il supporto SAML per il portale richiede che tu abbia già installato e configurato il modulo SSO di Edge sul nodo Edge Management Server. La procedura generale per attivare SAML per il portale è la seguente:

  1. Configura SAML su Edge come descritto in Installazione e configurazione di SAML per Edge. Nota: per installare il portale, l'autenticazione di base deve essere ancora attivata su Edge. Non disattivare l'autenticazione di base su Edge finché non hai configurato il portale per l'utilizzo di SAML.
  2. Installa il portale e assicurati che l'installazione funzioni correttamente. Consulta Installazione del portale Edge for Private Cloud.
  3. Configura SAML sul portale.
  4. Ora puoi disattivare l'autenticazione di base su Edge.

Creazione di un utente della macchina per il portale

Quando SAML è attivato, Edge supporta la generazione automatica di token OAuth2 tramite l'utilizzo di utenti macchina. Un utente della macchina può ottenere token OAuth2 senza dover specificare un passcode. Ciò significa che puoi automatizzare completamente la procedura di acquisizione e aggiornamento dei token OAuth2.

La procedura di configurazione SAML per il portale crea automaticamente un utente macchina nell'organizzazione associata al portale. Il portale utilizza quindi questo account utente della macchina per collegarsi a Edge. Per saperne di più sugli utenti macchina, vedi Utilizzare SAML con le attività automatiche.

Informazioni sull'autenticazione per gli account sviluppatore del portale

Quando configuri il portale per l'utilizzo di SAML, lo consenti di utilizzare SAML per autenticarsi con Edge in modo che possa inviare richieste a Edge. Tuttavia, il portale supporta anche un tipo di utente chiamato sviluppatore.

Gli sviluppatori costituiscono la community di utenti che creano app utilizzando le tue API. Gli sviluppatori di app utilizzano il portale per scoprire di più sulle tue API, registrare le app che le utilizzano, interagire con la community di sviluppatori e visualizzare informazioni statistiche sull'utilizzo delle loro app su una dashboard.

Quando uno sviluppatore accede al portale, è il portale stesso a essere responsabile dell'autenticazione dello sviluppatore e dell'applicazione delle autorizzazioni basate sui ruoli. Il portale continua a utilizzare l'autenticazione di base con gli sviluppatori anche dopo aver attivato SAML tra il portale e Edge. Per saperne di più, consulta Comunicazione tra il portale e Edge.

È possibile configurare il portale anche per utilizzare SAML per autenticare gli sviluppatori. Per un esempio di attivazione di SAML utilizzando moduli Drupal di terze parti, consulta Integrazione SSO tramite SAML con il portale per gli sviluppatori.

Configura SAML sul portale per comunicare con Edge

Per configurare SAML per il portale, devi creare un file di configurazione per configurare il portale:

# 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

Per attivare il supporto di SAML sul portale:

  1. Nell'interfaccia utente di Edge, aggiungi l'utente della macchina specificato da DEVPORTAL_ADMIN_EMAIL all'organizzazione associata al portale come Amministratore dell'organizzazione.
  2. Esegui il seguente comando per configurare SAML sul portale: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    dove samlConfigFile è il file di configurazione SAML.

  3. Accedi al portale come amministratore.
  4. Nel menu principale di Drupal, seleziona Configurazione > Dev Portal. Viene visualizzata la schermata di configurazione del portale, incluse le impostazioni SAML:

    Tieni presente che la casella Questa organizzazione è abilitata per SAML è selezionata, l'endpoint per il modulo SSO di Edge è compilato, i campi API key e Consumer secret per il client OAuth del portale sono compilati e il messaggio Connessione riuscita viene visualizzato sotto il pulsante Test connessione.

  5. Puoi premere il pulsante Testa connessione per verificare nuovamente la connessione in qualsiasi momento.

Per modificare in un secondo momento questi valori, aggiorna il file di configurazione ed esegui di nuovo il comando.

Disattivare SAML sul portale

Se scegli di disattivare SAML per le comunicazioni tra il portale e Edge, il portale non potrà più inviare richieste a Edge. Gli sviluppatori possono accedere al portale, ma non potranno visualizzare il prodotto o creare app.

Per disattivare SAML sul portale:

  1. Modifica il file di configurazione utilizzato per configurare SAM in modo da impostare: 
    DEVPORTAL_SSO_ENABLED=n
  2. Configura il portale: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile