使用 apigee-ssoadminapi.sh

私有雲 v4.18.01 的邊緣

Edge SSO 模組支援兩種帳戶類型:

  • 管理員
  • 機器使用者

apigee-ssoadminapi.sh 公用程式可讓您管理與 Edge SSO 模組相關聯的管理員和機器使用者。

使用 apigee-ssoadminapi.sh 公用程式:

  • 查看管理員/電腦使用者清單
  • 新增或刪除管理員/電腦使用者
  • 變更管理員/電腦使用者的密碼

關於管理員使用者

需要 Edge SSO 模組上的管理員帳戶才能管理模組的屬性。您還需要管理員帳戶憑證才能設定 API BaaS 或入口網站,才能連結至模組。

根據預設,安裝 Edge SSO 模組時,系統會建立含有下列憑證的管理員帳戶:

  • username:由用來設定 Edge SSO 模組的設定檔中的 SSO_ADMIN_NAME 屬性定義。預設值為 ssoadmin.
  • password:由用來設定 Edge SSO 模組的設定檔中的 SSO_ADMIN_SECRET 屬性定義。

關於電腦使用者

電腦使用者不必指定密碼即可取得 OAuth2 權杖。這表示您可以使用 Edge Management API 完全自動化取得及更新 OAuth2 權杖的程序。

你通常會將機器使用者用於下列用途:

  • 設定開發人員服務入口網站以與 Edge 通訊
  • 開發環境支援常見開發工作 (例如測試自動化或持續整合/持續部署 (CI/CD)) 的自動化作業。

詳情請參閱將 SAML 與自動化工作搭配使用

安裝 apigee-ssoadminapi.sh

在已安裝 Edge SSO 模組的 Edge Management Server 節點中,安裝 apigee-ssoadminapi.sh 公用程式。通常您會在安裝 Edge SSO 模組時安裝 apigee-ssoadminapi.sh 公用程式。

如果您尚未安裝 apigee-ssoadminapi.sh 公用程式:

  1. 登入 Management Server 節點。該節點應已安裝 apigee-service,詳情請參閱安裝 Edge apigee-setup 公用程式
  2. 升級這個 apigee-ssoadminapi.sh 公用程式,用於管理邊緣單一登入 (SSO) 模組的管理員和機器使用者:
    >
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. 登出殼層,然後再次登入,將 apigee-ssoadminapi.sh 公用程式新增至路徑。

查看 apigee-ssoadminapi.sh 的說明資訊

這個公用程式可用的指令如下:

  • 管理員新增
  • 管理員刪除
  • 管理員清單
  • 管理員設定密碼
  • SAML 機器使用者新增
  • SAML 機器使用者刪除
  • Aaml 機器使用者清單
  • SAML 機器使用者設定密碼

您可以在 /opt/apigee/apigee-ssoadminapi/README.md 檔案查看這些指令的相關資訊。此外,您也可以為每個指令指定「-h」選項,藉此查看使用資訊。例如下列指令:

> apigee-ssoadminapi.sh admin list -h

會傳回:

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

叫用 apigee-ssoadminapi.sh 公用程式

如要叫用 apigee-ssoadminapi.sh 公用程式,只要將所有屬性做為指令列引數傳遞,或是以互動模式回應提示即可。

舉例來說,如要在指令列中指定所有必要資訊,以便查看管理員使用者清單,請按照下列步驟操作:

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

會傳回:

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

如果省略任何必要資訊 (例如管理員密碼),系統會提示您。

在此範例中,您可以省略 --port--ssl 的值,因為 Edge SSO 模組在 --port 使用預設值 9099,在 --ssl 中使用 http。如果安裝時不使用這些預設值,請指定:

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

或者,請使用互動式表單,系統會提示您輸入所有資訊:

> apigee-ssoadminapi.sh admin list

接著系統會提示您輸入所有必要資訊:

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