使用 apigee-ssoadminapi.sh

Private Cloud 適用的 Edge 4.17.09 版

Edge 單一登入模組支援兩種類型的帳戶:

  • administrator
  • 電腦使用者

apigee-ssoadminapi.sh 公用程式可讓您管理與 Edge 單一登入 (SSO) 模組相關聯的 adminiatrator 和機器使用者。

使用 apigee-ssoadminapi.sh 公用程式執行以下操作:

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

關於管理員使用者

您必須使用 Edge SSO 模組的管理員帳戶,才能管理模組的資源。您也需要管理員帳戶憑證,才能設定 API BaaS 或入口網站,以便連結至模組。

根據預設,安裝 Edge 單一登入模組時,系統會使用下列憑證建立管理員帳戶:

  • 使用者名稱:由用於設定 Edge SSO 模組的設定檔中的 SSO_ADMIN_NAME 屬性定義。預設值為 ssoadmin
  • 密碼:由用於設定 Edge SSO 模組的設定檔中的 SSO_ADMIN_SECRET 屬性定義。

關於機器使用者

機器使用者可以取得 OAuth2 權杖,而無須指定密碼。也就是說,您可以使用 Edge 管理 API 完全自動化取得及重新整理 OAuth2 權杖的程序。

您通常會使用裝置使用者處理下列事務:

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

詳情請參閱「使用 SAML 搭配自動化工作」。

安裝 apigee-ssoadminapi.sh

在已安裝 Edge SSO 模組的 Edge 管理伺服器節點上,安裝 apigee-ssoadminapi.sh 公用程式。通常在安裝 Edge SSO 模組時,您會安裝 apigee-ssoadminapi.sh 公用程式。

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

  1. 登入管理伺服器節點。該節點應已安裝 apigee-service,如「安裝 Edge apigee-setup 公用程式」一文所述。
  2. 安裝 apigee-ssoadminapi.sh 公用程式,用於管理 Edge 單一登入 (SSO) 模組的管理員和機器使用者:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. 登出殼層,然後重新登入,將 apigee-ssoadminapi.sh 公用程式新增至路徑。

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

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

  • 管理員新增
  • 管理員刪除
  • 管理員清單
  • 管理員 setpassword
  • saml machineuser add
  • saml machineuser delete
  • aml machineuser 清單
  • saml machineuser setpassword

您可以在 /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