Korzystanie z apigee-ssoadminapi.sh

Edge for Private Cloud w wersji 4.19.01

Moduł Edge SSO obsługuje 2 typy kont:

  • administrator
  • użytkownik komputera (tylko SAML)

Narzędzie apigee-ssoadminapi.sh umożliwia zarządzanie administratorem i komputerem z modułem Edge SSO.

Za pomocą narzędzia apigee-ssoadminapi.sh możesz:

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

Informacje o administratorach

Do zarządzania właściwościami aplikacji wymagane jest konto administratora w module Edge SSO .

Domyślnie, gdy instalujesz moduł Edge SSO, tworzone jest konto administratora z następujące dane logowania:

  • username: zdefiniowana przez właściwość SSO_ADMIN_NAME w parametrze służący do konfigurowania modułu Edge SSO. Wartość domyślna to ssoadmin..
  • password: zdefiniowane przez właściwość SSO_ADMIN_SECRET w parametrze służący do konfigurowania modułu Edge SSO.

Informacje o użytkownikach komputerów

Użytkownik komputera może uzyskiwać 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ług dla deweloperów Apigee (lub po prostu portalu) na potrzeby komunikacji z Edge
  • Gdy środowisko programistyczne obsługuje automatyzację w przypadku typowych zadań programistycznych, takich jak testowanie automatyzacja lub tryb ciągłej integracji/ciągłego wdrażania (CI/CD).

Więcej informacji znajdziesz w artykule Używanie SAML do zadań automatycznych.

Instalowanie pliku apigee-ssoadminapi.sh

Zainstaluj narzędzie apigee-ssoadminapi.sh w węźle serwera zarządzania brzegiem, w którym zainstalowano moduł Edge SSO. Zwykle instalujesz apigee-ssoadminapi.sh podczas instalowania modułu Edge SSO.

Jeśli narzędzie apigee-ssoadminapi.sh nie zostało jeszcze zainstalowane:

  1. Zaloguj się w węźle serwera zarządzania. Ten węzeł powinien już mieć Aplikacja apigee-service została zainstalowana zgodnie z opisem na stronie Instalowanie konfiguracji Edge Apigee .
  2. Zainstaluj narzędzie apigee-ssoadminapi.sh używane do zarządzania administratorem i użytkownikami maszyn dla modułu Edge SSO: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Wyloguj się z powłoki i zaloguj się ponownie, aby dodać narzędzie apigee-ssoadminapi.sh na ścieżce.

Wyświetlanie informacji pomocy dla apigee-ssoadminapi.sh

Dostępne polecenia dotyczące narzędzia to:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Informacje o tych poleceniach możesz wyświetlić w /opt/apigee/apigee-ssoadminapi/README.md . Możesz też określić parametr „-h”, 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żna 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 podać w wierszu poleceń wszystkie wymagane informacje w celu wyświetlenia listy administratorów użytkownicy:

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

Zwraca:

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

Jeśli pominiesz jakiekolwiek wymagane informacje, na przykład hasło administratora, pojawi się odpowiedni komunikat.

W tym przykładzie pominiesz wartości --port i --ssl, ponieważ moduł Edge SSO używa wartości domyślnych 9099 dla interfejsu --port, a dla protokołu HTTP. --ssl Jeśli Twoja instalacja nie używa tych wartości domyślnych, 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

Pojawi się prośba o podanie wszystkich wymaganych informacji:

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