使用 apigee-ssoadminapi.sh

Edge for Private Cloud v4.18.01

Edge SSO 模块支持两种类型的账号：

  • administrator
  • 计算机用户

借助 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 管理服务器节点上安装 apigee-ssoadminapi.sh 实用程序。通常，您会在安装 Edge SSO 模块时安装 apigee-ssoadminapi.sh 实用程序。

如果您尚未安装 apigee-ssoadminapi.sh 实用程序，请执行以下操作：

  1. 登录管理服务器节点。该节点应该已经安装了 apigee-service，如安装 Edge apigee-setup 实用程序中所述。
  2. 安装用于管理 Edge SSO 模块的管理员和机器用户的 apigee-ssoadminapi.sh 实用程序：
    >     /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. 退出 shell，然后重新登录，以将 apigee-ssoadminapi.sh 实用程序添加到您的路径。

查看 apigee-ssoadminapi.sh 的帮助信息

该实用程序的可用命令如下：

  • admin add
  • 管理员删除
  • 管理员列表
  • 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

returns:

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

returns:

[
  {
    "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