Korzystanie z apigee-ssoadminapi.sh

Edge for Private Cloud w wersji 4.18.05

Moduł Edge SSO obsługuje 2 typy kont:

  • administrator
  • użytkownik komputera

Narzędzie apigee-ssoadminapi.sh umożliwia zarządzanie administratorem i użytkownikami komputera powiązanymi z modułem logowania jednokrotnego na serwerach brzegowych.

apigee-ssoadminapi.sh służy do:

  • Wyświetlanie listy administratorów lub użytkowników komputera
  • Dodawanie i usuwanie administratorów lub użytkowników komputera
  • Zmiana haseł administratorów/użytkowników komputera

Informacje o administratorach

Do zarządzania jego właściwościami wymagane jest konto administratora w module logowania jednokrotnego na serwerach brzegowych.

Domyślnie podczas instalacji modułu logowania jednokrotnego na serwerach brzegowych tworzone jest konto administratora z tymi danymi logowania:

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

Informacje o użytkownikach komputerów

Użytkownik komputera może uzyskać 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.

Zwykle używasz komputerów do:

  • Konfigurowanie portalu Apigee Developer Services (lub portalu) do komunikowania się z Edge
  • Gdy środowisko programistyczne obsługuje automatyzację 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 Używanie SAML do obsługi zadań automatycznych.

Instalowanie pliku apigee-ssoadminapi.sh

Zainstaluj narzędzie apigee-ssoadminapi.sh w węźle serwera zarządzania brzegowym, w którym zainstalowano moduł Edge SSO. Zazwyczaj instalujesz narzędzie apigee-ssoadminapi.sh podczas instalowania modułu logowania jednokrotnego na serwerach brzegowych.

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

  1. Zaloguj się w węźle serwera zarządzania. W tym węźle powinien być już zainstalowany apigee-service zgodnie z opisem w sekcji Instalowanie narzędzia Edge apigee-setup.
  2. Zainstaluj narzędzie apigee-ssoadminapi.sh używane do zarządzania administratorami i użytkownikami komputera w module logowania jednokrotnego na serwerach brzegowych: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Wyloguj się z powłoki, a potem zaloguj się ponownie, by dodać do ścieżki narzędzie apigee-ssoadminapi.sh.

Wyświetlanie informacji pomocy dotyczącej pliku apigee-ssoadminapi.sh

Dostępne polecenia 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 pliku /opt/apigee/apigee-ssoadminapi/README.md. Oprócz tego możesz dodać opcję „-h” do każdego polecenia, aby wyświetlić informacje o wykorzystaniu.

Na przykład to 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

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

Aby na przykład podać w wierszu poleceń wszystkie informacje wymagane do wyświetlenia listy administratorów:

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 jakiekolwiek wymagane informacje, takie jak hasło administratora, pojawi się odpowiedni komunikat.

W tym przykładzie pomijasz wartości --port i --ssl, ponieważ moduł Edge SSO używa wartości domyślnych 9099 dla --port i http dla --ssl. Jeśli w Twojej instalacji nie są używane te wartości domyślne, podaj 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

Zobaczysz prośbę o podanie wszystkich wymaganych informacji:

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