Korzystanie z apigee-ssoadminapi.sh

Edge for Private Cloud w wersji 4.18.01

Moduł Edge SSO obsługuje 2 typy kont:

  • administrator
  • Użytkownik maszyny

Plik apigee-ssoadminapi.sh umożliwia zarządzanie administratorem i użytkownikami maszyn powiązanymi z Edge SSO .

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

  • Wyświetlanie listy administratorów/użytkowników urządzenia
  • Dodawanie lub usuwanie administratora/użytkowników urządzenia
  • Zmiana hasła użytkowników z poziomu administracyjnego lub maszyny

Użytkownicy z uprawnieniami administracyjnymi

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

Domyślnie podczas instalacji modułu Edge SSO tworzone jest konto administratora z następujące dane logowania:

  • username: zdefiniowany przez właściwość SSO_ADMIN_NAME w pliku konfiguracyjnym służącym do konfigurowania modułu SSO w 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.

Informacje o użytkownikach komputerów

Użytkownik maszyny może uzyskać tokeny OAuth2 bez konieczności podawania kodu dostępu. Oznacza to, że może całkowicie zautomatyzować proces uzyskiwania i odświeżania tokenów OAuth2 za pomocą przeglądarki Edge do zarządzania interfejsami API.

Użytkowników komputerów 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 testowanie do automatyzacji lub ciągłego wdrażania (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. Zwykle instalujesz Narzędzie apigee-ssoadminapi.sh podczas instalowania modułu Edge SSO.

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

  1. Zaloguj się w węźle serwera zarządzania. Ten węzeł powinien już mieć zainstalowaną usługę apigee-service zgodnie z opisem na stronie Instalowanie konfiguracji Edge Apigee .
  2. Zainstaluj narzędzie apigee-ssoadminapi.sh służące do zarządzania użytkownikami administracyjnymi i automatycznymi w module SSO Edge:
    >
    /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:

  • admin add
  • usunięcie przez administratora
  • lista administratorów
  • admin setpassword
  • Dodanie użytkownika maszyny SAML
  • Usunięcie użytkownika maszyny SAML
  • lista użytkowników maszyn aml
  • Ustawienie hasła użytkownika maszyny SAML

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

> apigee-ssoadminapi.sh admin list -h

zwraca:

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

Możesz wywołać narzędzie apigee-ssoadminapi.sh, przekazując wszystkie jako argumentów 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ż skorzystać z interaktywnego formularza, w którym poprosimy Cię o podanie wszystkich informacji:

> 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