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

Edge per Private Cloud v4.18.01

Il portale Servizi per sviluppatori funge da client di Apigee Edge. Ciò significa che il portale non funzionano come un sistema autonomo. Al contrario, molte delle informazioni usate dal portale sono in realtà archiviati 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 puoi specificare le credenziali di autenticazione di base (nome utente e password) per un dell'organizzazione utilizzato dal portale per comunicare con Edge.

Se scegli di abilitare SAML per l'autenticazione perimetrale, puoi configurare il portale in modo che utilizzi Autenticazione SAML durante l'invio di richieste a Edge. Configurazione del portale per l'uso di SAML crea automaticamente un nuovo account utente nell'organizzazione Edge che verrà quindi per effettuare richieste a Edge. Per saperne di più sugli utenti di macchine, vedi Utilizzo di SAML con attività automatizzate.

Il supporto SAML per il portale richiede che tu abbia già installato e configurato Edge Modulo SSO sul nodo Edge Management Server. La procedura generale per l'attivazione di SAML per del portale è:

  1. Configura SAML su Edge come descritto in Installazione e configurazione di SAML per Edge. Nota: l'autenticazione di base deve essere ancora abilitata su Edge per installare portale. Non disabilitare l'autenticazione di base su Edge finché non hai configurato il portale per l'utilizzo SAML.
  2. Installa il portale e assicurati che l'installazione funzioni correttamente. Consulta l'articolo Installazione di Edge per privati dal portale Cloud Developer Services.
  3. Configura SAML sul portale.
  4. Ora puoi disabilitare l'autenticazione di base su Edge.

Creazione di un utente della macchina per il portale

Quando SAML è abilitato, Edge supporta la generazione automatica di token OAuth2 tramite l'uso di utenti di macchine. Un utente della macchina può ottenere i token OAuth2 senza dover specificare un passcode. Ciò significa che è possibile automatizzare completamente il processo di acquisizione e aggiornamento di OAuth2. di token.

Il processo di configurazione SAML per il portale crea automaticamente un utente macchina nell' associata al portale, Il portale utilizza quindi questo account utente della macchina connettersi a Edge. Per ulteriori informazioni sugli utenti di macchine, vedi Utilizzo SAML con attività automatizzate.

Informazioni sull'autenticazione per lo sviluppatore del portale account

Quando configuri il portale per l'utilizzo di SAML, attivi il portale in modo che utilizzi SAML per l'autenticazione con Edge, in modo che il portale possa effettuare richieste a Edge. Tuttavia, il portale supporta anche un tipo di utenti chiamati sviluppatori.

Gli sviluppatori costituiscono la community di utenti che creano app utilizzando le tue API. Sviluppatori di app usa il portale per conoscere le tue API, registrare app che le usano, interagire con la community degli sviluppatori e di visualizzare informazioni statistiche sull'utilizzo dell'app su un Fitbit.com.

Quando uno sviluppatore accede al portale, quest'ultimo è responsabile per l'autenticazione dello sviluppatore e per l'applicazione delle autorizzazioni basate sui ruoli. Il portale continua Utilizzare l'autenticazione di base con gli sviluppatori anche dopo aver attivato SAML tra il portale ed Edge. Per ulteriori informazioni, vedi Comunicazione tra il portale ed Edge.

È anche possibile configurare il portale in modo che utilizzi SAML per autenticare gli sviluppatori. Per un esempio sull'attivazione di SAML utilizzando moduli Drupal di terze parti, consulta https://community.apigee.com/articles/29201/sso-integration-via-saml-with-developer-portal.html.

Configura SAML sul portale per comunicare con Edge

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

# 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 SAML sul portale:

  1. Nella UI di Edge, aggiungi all'organizzazione l'utente della macchina specificato da DEVPORTAL_ADMIN_EMAIL associata al portale come amministratore dell'organizzazione.
    Nota: l'utente della macchina non esiste ancora, ma viene creato automaticamente nella al passaggio successivo.
  2. Esegui questo 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 del portale.
  4. Nel menu principale di Drupal, seleziona Configurazione > Portale per sviluppatori. Il portale viene visualizzata la schermata di configurazione, incluse le impostazioni SAML:

    Tieni presente che la casella per Questa organizzazione è abilitata per SAML è selezionato, l'endpoint per il modulo SSO Edge sia compilato, la chiave API e I campi Segreto utente per il client OAuth del portale sono compilati e i campi viene visualizzato il messaggio Connessione riuscita nella sezione Test Connessione.

  5. Puoi premere il pulsante Verifica connessione per ripetere il test della connessione all'indirizzo in qualsiasi momento.

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

Disattiva SAML sul portale

Se scegli di disattivare SAML per le comunicazioni tra il portale ed Edge, il portale non sarà più in grado di effettuare richieste a Edge. Gli sviluppatori possono accedere al portale, non sarà in grado di visualizzare il prodotto o creare app.

Attenzione: se disattivi SAML, devi riconfigurarlo il portale per utilizzare SAML oppure, se Edge è ancora configurato per supportare l'autenticazione di base, configura il portale comunicare con Edge usando l'autenticazione di base. Per ulteriori informazioni sull'uso di Autorizzazione di base, consulta l'argomento Comunicazione tra il portale ed Edge.

Per disattivare SAML sul portale:

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