Apigee-ssoadminapi.sh verwenden

Das Apigee SSO-Modul unterstützt zwei Arten von Konten:

Mit dem Dienstprogramm apigee-ssoadminapi.sh können Sie die Administrator- und Computernutzerkonten verwalten, die mit dem Apigee SSO-Modul verknüpft sind.

Mit dem Dienstprogramm apigee-ssoadminapi.sh können Sie Folgendes tun:

  • Liste der Administratoren/Computernutzer aufrufen
  • Administratoren/Computernutzer hinzufügen oder löschen
  • Passwort von Administratoren/Computernutzern ändern

Informationen zu Administratornutzern

Ein Administratorkonto für das Apigee-SSO-Modul ist erforderlich, um Attribute des Moduls zu verwalten.

Wenn Sie das Apigee-SSO-Modul installieren, wird standardmäßig ein Administratorkonto mit den folgenden Anmeldedaten erstellt:

  • username: Wird durch das Attribut SSO_ADMIN_NAME in der Konfigurationsdatei definiert, die zum Konfigurieren des Apigee SSO-Moduls verwendet wird. Der Standardwert ist ssoadmin.
  • password: Wird durch das Attribut SSO_ADMIN_SECRET in der Konfigurationsdatei definiert, die zum Konfigurieren des Apigee SSO-Moduls verwendet wird.

Informationen zu Computernutzern

Ein Computernutzer kann OAuth2-Tokens erhalten, ohne einen Sicherheitscode angeben zu müssen. Das bedeutet, dass Sie den Vorgang des Abrufens und Aktualisierens von OAuth2-Tokens mithilfe der Edge-Verwaltungs-API vollständig automatisieren können.

Computernutzer werden normalerweise für Folgendes eingesetzt:

  • Konfigurieren des Apigee Developer Services-Portals (oder einfach das Portal) für die Kommunikation mit Edge
  • Wenn die Entwicklungsumgebung die Automatisierung für allgemeine Entwicklungsaufgaben wie Testautomatisierung oder CI/CD unterstützt.

Weitere Informationen finden Sie unter Aufgaben für externe IdPs automatisieren.

Apigee-ssoadminapi.sh installieren

Installieren Sie das Dienstprogramm apigee-ssoadminapi.sh auf dem Edge Management Server-Knoten, auf dem Sie das Apigee SSO-Modul installiert haben. In der Regel installieren Sie das Dienstprogramm apigee-ssoadminapi.sh bei der Installation des Apigee SSO-Moduls.

Wenn Sie das Dienstprogramm apigee-ssoadminapi.sh noch nicht installiert haben:

  1. Melden Sie sich im Verwaltungsserver-Knoten an. Auf diesem Knoten sollte apigee-service bereits installiert sein, wie unter Dienstprogramm für Edge Apigee-Setup installieren beschrieben.
  2. Installieren Sie das Dienstprogramm apigee-ssoadminapi.sh, mit dem Administratoren und Computernutzer für das Apigee-SSO-Modul verwaltet werden. Führen Sie dazu den folgenden Befehl aus: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Melden Sie sich von der Shell ab und anschließend wieder an, um Ihrem Pfad das Dienstprogramm apigee-ssoadminapi.sh hinzuzufügen.

Hilfeinformationen zu apigee-ssoadminapi.sh ansehen

Für das Dienstprogramm sind folgende Befehle verfügbar:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add (verwenden Sie den Befehl saml für alle IdPs, einschließlich LDAP und SAML)
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Informationen zu diesen Befehlen finden Sie in der Datei /opt/apigee/apigee-ssoadminapi/README.md. Außerdem können Sie für jeden Befehl die Option „-h“ angeben, um Nutzungsinformationen aufzurufen.

Beispiel:

apigee-ssoadminapi.sh admin list -h

Retouren:

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

Rufen Sie das Dienstprogramm apigee-ssoadminapi.sh auf

Sie können das Dienstprogramm apigee-ssoadminapi.sh aufrufen, indem Sie alle Attribute als Befehlszeilenargumente übergeben, oder im interaktiven Modus auf Eingabeaufforderungen antworten.

So geben Sie beispielsweise alle erforderlichen Informationen in der Befehlszeile an, um die Liste der Administratoren aufzurufen:

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

Retouren:

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

Wenn Sie alle erforderlichen Informationen auslassen, z. B. das Administratorpasswort, werden Sie dazu aufgefordert.

In diesem Beispiel lassen Sie die Werte für --port und --ssl weg, da das Apigee-SSO-Modul die Standardwerte 9099 für --port und http für --ssl verwendet. Wenn Ihre Installation diese Standardeinstellungen nicht verwendet, geben Sie sie an:

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

Alternativ können Sie das interaktive Formular verwenden, in dem Sie zur Eingabe aller Informationen aufgefordert werden:

apigee-ssoadminapi.sh admin list

Anschließend werden Sie zur Eingabe aller erforderlichen Informationen aufgefordert:

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