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 Maschinennutzerkonten verwalten, die dem Apigee-SSO-Modul zugeordnet sind.

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

  • Liste der Administratoren/Maschinennutzer aufrufen
  • Admin-/Maschinennutzer hinzufügen oder löschen
  • Passwort von Administrator-/Maschinennutzern ändern

Administratornutzer

Zum Verwalten der Attribute des Moduls ist ein Administratorkonto im Apigee-SSO-Modul erforderlich.

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: Definiert durch das Attribut SSO_ADMIN_SECRET in der Konfigurationsdatei, die zum Konfigurieren des Apigee-SSO-Moduls verwendet wird.

Informationen zu Computernutzern

Ein Maschinennutzer kann OAuth2-Tokens abrufen, ohne einen Passcode angeben zu müssen. Das bedeutet, dass Sie den Prozess zum Abrufen und Aktualisieren von OAuth2-Tokens mithilfe der Edge Management API vollständig automatisieren können.

Maschinennutzer werden in der Regel für Folgendes verwendet:

  • Konfigurieren des Apigee Developer Services-Portals (oder einfach des Portals) für die Kommunikation mit Edge
  • Wenn die Entwicklungsumgebung die Automatisierung gängiger 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, wenn Sie das Apigee-SSO-Modul installieren.

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

  1. Melden Sie sich beim Management Server-Knoten an. Auf diesem Knoten sollte apigee-service bereits installiert sein, wie unter Edge-Dienstprogramm „apigee-setup“ installieren beschrieben.
  2. Installieren Sie das Dienstprogramm apigee-ssoadminapi.sh, mit dem Administrator- und Maschinennutzer für das Apigee-SSO-Modul verwaltet werden, indem Sie den folgenden Befehl ausführen: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Melden Sie sich von der Shell ab und dann wieder an, um das Dienstprogramm apigee-ssoadminapi.sh Ihrem Pfad hinzuzufügen.

Hilfeinformationen für apigee-ssoadminapi.sh aufrufen

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

Liefert:

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

Dienstprogramm „apigee-ssoadminapi.sh“ aufrufen

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

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

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

Liefert:

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

Wenn Sie erforderliche Informationen wie das Administratorpasswort weglassen, 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 Standardwerte 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 alle Informationen eingeben müssen:

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