Mit Apigee-ssoadminapi.sh

Edge for Private Cloud Version 4.17.09

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

  • administrator
  • Nutzer des Geräts

Mit dem Dienstprogramm apigee-ssoadminapi.sh können Sie die Administratoren und Maschinennutzer verwalten, die mit dem Edge-SSO-Modul verknüpft sind.

Verwenden Sie das Dienstprogramm apigee-ssoadminapi.sh für Folgendes:

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

Administratoren

Ein Administratorkonto für das Edge-SSO-Modul ist erforderlich, um die Properties des Moduls zu verwalten. Außerdem benötigen Sie Anmeldedaten für ein Administratorkonto, um API BaaS oder das Portal für die Verbindung zum Modul zu konfigurieren.

Wenn Sie das Edge-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 Edge-SSO-Moduls verwendet wird. Der Standardwert ist ssoadmin.
  • password: wird durch die Eigenschaft SSO_ADMIN_SECRET in der Konfigurationsdatei definiert, die zum Konfigurieren des Edge-SSO-Moduls verwendet wird.

Computernutzer

Ein Nutzer eines Geräts kann OAuth2-Tokens abrufen, ohne einen Sicherheitscode angeben zu müssen. Das bedeutet, dass Sie den Abruf und die Aktualisierung von OAuth2-Tokens mithilfe der Edge-Verwaltungs-API vollständig automatisieren können.

Sie verwenden Maschinennutzer in der Regel für:

  • Das Entwicklerdienste-Portal für die Kommunikation mit Edge konfigurieren
  • Ob die Entwicklungsumgebung die Automatisierung gängiger Entwicklungsaufgaben unterstützt, z. B. die Testautomatisierung oder Continuous Integration/Continuous Deployment (CI/CD).

Weitere Informationen finden Sie unter SAML mit automatisierten Aufgaben verwenden.

apigee-ssoadminapi.sh installieren

Installieren Sie das Dienstprogramm apigee-ssoadminapi.sh auf dem Edge-Verwaltungsserverknoten, auf dem Sie das Edge-SSO-Modul installiert haben. Normalerweise installieren Sie das Dienstprogramm apigee-ssoadminapi.sh, wenn Sie das Edge SSO-Modul installieren.

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

  1. Melden Sie sich beim Knoten des Verwaltungsservers an. Auf diesem Knoten sollte bereits apigee-service installiert sein, wie unter Installieren Sie das Hilfsprogramm für das Edge-Apigee-Setup beschrieben.
  2. Installieren Sie das Dienstprogramm apigee-ssoadminapi.sh, mit dem Administrator- und Maschinennutzer für das Edge SSO-Modul verwaltet werden:
    >     /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Melden Sie sich von der Shell ab und dann wieder an, um dem Pfad das Dienstprogramm apigee-ssoadminapi.sh hinzuzufügen.

Hilfeinformationen für apigee-ssoadminapi.sh anzeigen

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

  • admin add
  • admin delete
  • Administratorliste
  • admin setpassword
  • saml machineuser add
  • SAML-Maschinennutzer löschen
  • 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 Informationen zur Verwendung aufzurufen. Beispiel:

> apigee-ssoadminapi.sh admin list -h

returns:

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 Eigenschaften als Befehlszeilenargumente übergeben, oder im interaktiven Modus, indem Sie auf Prompts reagieren.

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

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

gibt Folgendes zurück:

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

Wenn Sie erforderliche Informationen wie das Administratorpasswort weglassen, werden Sie aufgefordert, sie anzugeben.

In diesem Beispiel lassen Sie die Werte für --port und --ssl weg, da das Edge-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 nach allen Informationen gefragt 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