使用 apigee-ssoadminapi.sh

Apigee SSO 模块支持两种类型的账号:

借助 apigee-ssoadminapi.sh 实用程序,您可以管理管理员和机器 与 Apigee SSO 模块关联的用户账号。

使用 apigee-ssoadminapi.sh 实用程序执行以下操作:

  • 查看管理员/机器用户列表
  • 添加或删除管理员/机器用户
  • 更改管理员/机器用户的密码

关于管理员用户

您必须拥有 Apigee SSO 模块的管理员账号才能管理 模块。

默认情况下,当您安装 Apigee SSO 模块时,它会创建一个具有 以下凭据:

  • username:由 SSO_ADMIN_NAME 属性定义 用于配置 Apigee SSO 模块的配置文件。默认值为 ssoadmin.
  • password:由 SSO_ADMIN_SECRET 属性定义 用于配置 Apigee SSO 模块的配置文件。

关于机器用户

机器用户无需指定密码即可获取 OAuth2 令牌。也就是说, 可以使用 Management API。

您通常需要使用机器用户执行以下操作:

  • 配置 Apigee Developer Services 门户(简称门户)以与 Edge 通信
  • 当开发环境支持自动化测试常见开发任务时 自动化或 CI/CD

如需了解详情,请参阅自动为外部 IDP 执行任务

安装 apigee-ssoadminapi.sh

在边缘管理服务器节点上安装apigee-ssoadminapi.sh实用程序,其中 您已安装了 Apigee SSO 模块。通常,您需要将 apigee-ssoadminapi.sh 实用程序(在安装 Apigee SSO 模块时)。

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

  1. 登录管理服务器节点。该节点应已 已按照以下网址中的说明安装 apigee-service安装 Edge apigee-setup 实用程序
  2. 安装用于管理管理员和机器的 apigee-ssoadminapi.sh 实用程序 用户启用 Apigee SSO 模块:
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. 退出 shell,然后再次登录,以添加 apigee-ssoadminapi.sh 实用程序添加到您的路径。

查看有关 apigee-ssoadminapi.sh

该实用程序的可用命令包括:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add(对所有 IDP 使用 saml 命令,包括 LDAP 和 SAML)
  • 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 的值,因为 对于 --port,Apigee SSO 模块使用默认值 9099,对于 --ssl。如果安装不使用这些默认值,请指定它们:

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