适用于私有云的 Edge v4.18.01
Edge SSO 模块支持两种类型的账号:
- administrator
- 机器用户
借助 apigee-ssoadminapi.sh 实用程序,您可以管理与 Edge SSO 模块关联的管理员和机器用户。
使用 apigee-ssoadminapi.sh 实用程序可执行以下操作:
- 查看管理员/机器用户列表
- 添加或删除管理员/机器用户
- 更改管理员/机器用户的密码
关于管理员用户
您必须拥有 Edge SSO 模块的管理员账号才能管理 模块。您还需要管理员账号凭据来配置 API BaaS 或门户, 连接到该模块
默认情况下,当您安装 Edge SSO 模块时,系统会创建一个具有以下凭据的管理员账号:
- username:由 SSO_ADMIN_NAME 属性定义 配置文件,用于配置 Edge SSO 模块。默认值为 ssoadmin。
- password:由 SSO_ADMIN_SECRET 属性定义 配置文件,用于配置 Edge SSO 模块。
关于机器用户
机器用户无需指定密码即可获取 OAuth2 令牌。也就是说, 可以使用 Management API。
您通常需要使用机器用户执行以下操作:
- 配置开发者服务门户以与 Edge 进行通信
- 当开发环境支持自动化测试常见开发任务时, 自动化或持续集成/持续部署 (CI/CD)。
有关详情,请参阅通过自动化操作使用 SAML 任务。
安装 apigee-ssoadminapi.sh
在您安装了 Edge SSO 模块的 Edge 管理服务器节点上安装 apigee-ssoadminapi.sh 实用程序。通常,您在安装 Edge SSO 模块时会安装 apigee-ssoadminapi.sh 实用程序。
如果您尚未安装 apigee-ssoadminapi.sh 实用程序,请执行以下操作:
- 登录管理服务器节点。该节点应已按如下方式安装 apigee-service 安装 Edge apigee-setup 实用性。
- 安装用于管理 Edge SSO 模块的管理员和机器用户的 apigee-ssoadminapi.sh 实用程序:
> /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install - 退出 shell,然后重新登录,将 apigee-ssoadminapi.sh 实用程序添加到您的路径中。
查看 apigee-ssoadminapi.sh 的帮助信息
该实用程序的可用命令如下:
- 管理员添加
- 管理员删除
- 管理员列表
- 管理员 setpassword
- saml machineuser add
- SAML Machineuser 删除
- aaml 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 和 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