Utilizzo di Apigee-ssoadminapi.sh

Edge for Private Cloud v4.19.01

Il modulo Edge SSO supporta due tipi di account:

  • administrator
  • Utente del computer (solo SAML)

L'utilità apigee-ssoadminapi.sh consente di gestire gli utenti amministratore e macchina associati al modulo Edge SSO.

Utilizza l'utilità apigee-ssoadminapi.sh per:

  • Visualizza l'elenco degli utenti amministratore/macchina
  • Aggiungi o elimina utenti amministratore/macchina
  • Modifica la password degli utenti amministratore/macchina

Informazioni sugli utenti con ruolo di amministratore

Per gestire le proprietà del modulo Edge SSO, è necessario un account amministratore nel modulo.

Per impostazione predefinita, quando installi il modulo Edge SSO, viene creato un account amministratore con le seguenti credenziali:

  • username: definito dalla proprietà SSO_ADMIN_NAME nel file di configurazione utilizzato per configurare il modulo Edge SSO. Il valore predefinito è ssoadmin.
  • password: definita dalla proprietà SSO_ADMIN_SECRET nel file di configurazione utilizzato per configurare il modulo Edge SSO.

Informazioni sugli utenti del computer

Un utente macchina può ottenere token OAuth2 senza dover specificare un passcode. Ciò significa che puoi automatizzare completamente il processo di ottenimento e aggiornamento dei token OAuth2 utilizzando l'API di gestione Edge.

In genere, gli utenti macchina vengono utilizzati per:

  • Configurazione del portale Apigee Developer Services (o semplicemente il portale) per comunicare con Edge
  • Quando l'ambiente di sviluppo supporta l'automazione per le attività di sviluppo comuni, come l'automazione dei test o l'integrazione continua/deployment continuo (CI/CD).

Per saperne di più, consulta Utilizzare SAML con le attività automatizzate.

Installazione di apigee-ssoadminapi.sh

Installa l'utilità apigee-ssoadminapi.sh sul nodo del server di gestione perimetrale in cui hai installato il modulo SSO perimetrale. In genere, l'utilità apigee-ssoadminapi.sh viene installata quando installi il modulo Edge SSO.

Se non hai ancora installato l'utilità apigee-ssoadminapi.sh:

  1. Accedi al nodo del server di gestione. In questo nodo deve essere già installato apigee-service, come descritto in Installa l'utilità apigee-setup di Edge.
  2. Installa l'utilità apigee-ssoadminapi.sh utilizzata per gestire gli utenti amministratori e delle macchine per il modulo SSO Edge: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Esci dalla shell e accedi di nuovo per aggiungere l'utilità apigee-ssoadminapi.sh al tuo percorso.

Visualizzazione delle informazioni della guida per apigee-ssoadminapi.sh

I comandi disponibili per l'utilità sono:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Puoi visualizzare le informazioni su questi comandi nel file /opt/apigee/apigee-ssoadminapi/README.md. Inoltre, puoi specificare l'opzione "-h" per ogni comando per visualizzare le informazioni sull'utilizzo.

Ad esempio, il seguente comando:

apigee-ssoadminapi.sh admin list -h

Restituisce:

admin list
  --admin SSOADMIN_CLIENT_NAME      Name of the client having administrative privilege on sso
  --secret SSOADMIN_CLIENT_SECRET   Secret/Password for the client
  --host SSO_HOST                   Hostname of SSO server to connect
  --port SSO_PORT                   Port to use during request
  --ssl SSO_URI_SCHEME              Set to https, defaults to http
  --debug                           Set in debug mode, turns on verbose in curl
  -h                                Displays Help

Chiamata dell'utilità apigee-ssoadminapi.sh

Puoi richiamare l'utilità apigee-ssoadminapi.sh passando tutte le proprietà come argomenti della riga di comando o in modalità interattiva rispondendo ai prompt.

Ad esempio, per specificare tutte le informazioni richieste nella riga di comando per visualizzare l'elenco degli utenti amministratori:

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184

Restituisce:

[
  {
    "client_id": "ssoadmin",
    "access_token_validity": 300
  }
]

Se ometti informazioni obbligatorie, ad esempio la password amministratore, ti verrà chiesto di inserirle.

In questo esempio, ometti i valori per --port e --ssl perché il modulo Edge SSO utilizza i valori predefiniti 9099 per --port e http per --ssl. Se la tua installazione non utilizza questi valori predefiniti, specificali:

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123
  --host 35.197.94.184 --port 9443 --ssl https

In alternativa, utilizza il modulo interattivo in cui ti vengono richieste tutte le informazioni:

apigee-ssoadminapi.sh admin list

Ti verrà quindi chiesto di fornire tutte le informazioni richieste:

SSO admin name (current): ssoadmin
SSO Admin secret (current):
SSO host: 35.197.94.184