使用 apigee-ssoadminapi.sh

Edge for Private Cloud 4.19.01 版

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

  • administrator
  • 機器使用者 (僅限 SAML)

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

apigee-ssoadminapi.sh 公用程式可用於：

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

關於管理員使用者

您必須具備 Edge SSO 模組的管理員帳戶，才能管理模組的屬性。

根據預設，安裝 Edge SSO 模組時，系統會建立管理員帳戶，並使用下列憑證：

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

關於機器使用者

機器使用者不必指定密碼，即可取得 OAuth2 權杖。也就是說，您可以使用 Edge Management API，完全自動化取得及重新整理 OAuth2 權杖的程序。

機器使用者通常用於：

  • 設定 Apigee Developer Services 入口網站 (或簡稱「入口網站」)，以便與 Edge 通訊
  • 開發環境支援常見開發工作的自動化，例如測試自動化或持續整合/持續部署 (CI/CD)。

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

安裝 apigee-ssoadminapi.sh

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

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

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

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

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

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • 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