Apigee SSO 模块支持两种类型的帐号:
借助 apigee-ssoadminapi.sh
实用程序,您可以管理与 Apigee SSO 模块关联的管理员和机器用户帐号。
使用 apigee-ssoadminapi.sh
实用程序执行以下操作:
- 查看管理员/机器用户的列表
- 添加或删除管理员/机器用户
- 更改管理员/机器用户的密码
关于管理员用户
您需要使用 Apigee SSO 模块的管理员账号才能管理该模块的属性。
默认情况下,当您安装 Apigee SSO 模块时,它会使用以下凭据创建管理员帐号:
- username:由用于配置 Apigee SSO 模块的配置文件中的
SSO_ADMIN_NAME
属性定义。默认值为ssoadmin.
- password:由用于配置 Apigee SSO 模块的配置文件中的
SSO_ADMIN_SECRET
属性定义。
关于计算机用户
机器用户可以获取 OAuth2 令牌,而无需指定密码。这意味着您可以使用 Edge Management API 完全自动执行获取和刷新 OAuth2 令牌的过程。
机器用户通常用于:
- 配置 Apigee Developer Services 门户(简称门户)以与 Edge 通信
- 开发环境支持以自动化方式执行常见开发任务,例如测试自动化或 CI/CD。
如需了解详情,请参阅为外部 IDP 自动执行任务。
安装 apigee-ssoadminapi.sh
在安装了 Apigee SSO 模块的边缘管理服务器节点上安装 apigee-ssoadminapi.sh
实用程序。通常,您在安装 Apigee SSO 模块时安装 apigee-ssoadminapi.sh
实用程序。
如果您尚未安装 apigee-ssoadminapi.sh
实用程序,请执行以下操作:
- 登录 Management Server 节点。该节点应已安装
apigee-service
,如安装 Edge apigee-setup 实用程序中所述。 - 执行以下命令,安装用于管理 Apigee SSO 模块的管理员和机器用户的
apigee-ssoadminapi.sh
实用程序:/opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
- 退出 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
的值,因为 Apigee 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