Korzystanie z apigee-ssoadminapi.sh

Edge for Private Cloud w wersji 4.17.09

Moduł logowania jednokrotnego w Edge obsługuje 2 rodzaje kont:

  • administrator
  • Użytkownik maszyny

Narzędzie apigee-ssoadminapi.sh umożliwia zarządzanie użytkownikami administratora i maszyn powiązanymi z modulem Edge SSO.

Za pomocą narzędzia apigee-ssoadminapi.sh możesz wykonywać te czynności:

  • Wyświetlanie listy użytkowników z poziomu administracyjnego lub maszynowego
  • Dodawanie i usuwanie administratora/użytkowników urządzenia
  • Zmiana hasła użytkowników o roli administratora lub maszyna

Użytkownicy z uprawnieniami administracyjnymi

Do zarządzania właściwościami w module Edge SSO wymagane jest konto administratora tego modułu. Aby skonfigurować BaaS API lub portal, aby połączyć się z modulem, musisz też mieć dane logowania do konta administratora.

Podczas instalacji modułu logowania jednorazowego w Edge domyślnie tworzone jest konto administratora z tymi danymi logowania:

  • username: zdefiniowany przez właściwość SSO_ADMIN_NAME w pliku konfiguracyjnym służącym do konfigurowania modułu SSO Edge. Wartość domyślna to ssoadmin.
  • password: zdefiniowane przez właściwość SSO_ADMIN_SECRET w pliku konfiguracji używanym do konfigurowania modułu SSO w Edge.

Użytkownicy maszyn

Użytkownik maszyny może uzyskiwać tokeny OAuth2 bez konieczności podawania kodu dostępu. Oznacza to, że możesz całkowicie zautomatyzować proces uzyskiwania i odświeżania tokenów OAuth2 za pomocą interfejsu Edge Management API.

Użytkowników maszyn używasz zwykle do:

  • Konfigurowanie portalu Usługi dla deweloperów do komunikacji z Edge
  • Gdy środowisko programistyczne obsługuje automatyzację w przypadku typowych zadań programistycznych, takich jak automatyzacja testów lub ciągła integracja/ciągłe wdrażanie (CI/CD).

Więcej informacji znajdziesz w artykule Korzystanie z protokołu SAML w przypadku zadań automatycznych.

Instalowanie pliku apigee-ssoadminapi.sh

Zainstaluj narzędzie apigee-ssoadminapi.sh na węźle serwera sterowania Edge, na którym zainstalowano moduł SSO Edge. Zazwyczaj instalujesz narzędzie apigee-ssoadminapi.sh podczas instalowania modułu SSO w usłudze Edge.

Jeśli nie masz jeszcze zainstalowanego narzędzia apigee-ssoadminapi.sh:

  1. Zaloguj się na węźle serwera zarządzania. Na tym węźle powinna być już zainstalowana usługa apigee-service zgodnie z opisem w artykule Instalowanie narzędzia do konfiguracji apigee w Edge.
  2. Zainstaluj narzędzie apigee-ssoadminapi.sh używane do zarządzania administratorami i użytkownikami maszyn na potrzeby modułu Edge SSO:
    >
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Wyloguj się z powłoki, a następnie zaloguj się ponownie, aby dodać narzędzie apigee-ssoadminapi.sh do ścieżki.

Wyświetlanie informacji o pliku apige-ssoadminapi.sh

Dostępne polecenia:

  • dodanie przez administratora
  • admin delete
  • lista administratorów
  • admin setpassword
  • Dodanie użytkownika maszyny SAML
  • saml machineuser delete
  • lista użytkowników maszyn aml
  • saml machineuser setpassword

Informacje na temat tych poleceń można wyświetlić w pliku /opt/apigee/apigee-ssoadminapi/README.md. Dodatkowo możesz dodać opcję „-h” do każdego polecenia, aby wyświetlić informacje o użyciu. Na przykład takie polecenie:

> apigee-ssoadminapi.sh admin list -h

zwroty:

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

Wywoływanie narzędzia apigee-ssoadminapi.sh

Narzędzie apigee-ssoadminapi.sh możesz wywołać, przekazując wszystkie właściwości jako argumenty wiersza poleceń lub w trybie interaktywnym, odpowiadając na prompty.

Aby na przykład określić wszystkie wymagane informacje w wierszu poleceń, aby wyświetlić listę użytkowników z rolą administratora:

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

zwroty:

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

Jeśli pominiesz wymagane informacje, np. hasło administratora, pojawi się odpowiedni komunikat.

W tym przykładzie pomijamy wartości parametrów --port--ssl, ponieważ moduł SSO w Edge używa wartości domyślnych 9099 dla parametru --port i http dla parametru --ssl. Jeśli Twoja instalacja nie korzysta z tych domyślnych wartości, określ je:

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

Możesz też użyć interaktywnego formularza, w którym znajdziesz wszystkie wymagane informacje:

> apigee-ssoadminapi.sh admin list

Następnie pojawi się prośba o podanie wszystkich wymaganych informacji:

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