AWS SSO单点登录管理参考指南

SSO API规范

1.验证Token

服务请求地址

向AWS发送请求的URL地址，该服务在安装本应用后自动提供。

假设AWS服务的访问地址是：https://abc.awspaas.com ，地址示例如下

https://abc.awspaas.com/r/jd

如果是开发者自己的本地开发环境，地址可能如下

http://localhost:8088/portal/r/jd

服务请求参数

请求处理结果

结果以json数据结构返回。假设要验证的tokenId为AAA，access_key为xxx-xxx，返回的数据结构如下

{
"data":{
"uid":"对应的AWS登录账户名",
"tokenId":"AAA",
"access_key":"xxx-xxx",
"validate":true
},
"msg":"",
"result":"ok"
}

• 当data/validate值为true时，表示该令牌有效
• 当result不为ok时，说明发生系统级错误，相关错误码请参考这里

• 当令牌验证通过后，会在json结果中提供uid，即该令牌对应的AWS登录账户，开发者可根据该账户在该系统的权限，返回对应在该系统的页面内容
• 如果Token提供的账户与第三方系统账户不一致，需要额外的实施和维护账户匹配规则（不在本应用标准功能之内）

2.刷新Token

默认，AWS的Session会话失效时间（sessionTimeout）被设置为30分钟。如果在30分钟内会话没有被刷新（用户每次在AWS内的操作，都会自动刷新一次会话活跃时间），该Token（AWS Session）将自动失效。

为了保持Token的活跃度，开发者可根据集成的需要在适当场景调用刷新Token的API，保持Token的活跃度。

服务请求地址

同验证Token

服务请求参数

请求处理结果

结果以json数据结构返回。假设要刷新的tokenId为AAA，access_key为xxx-xxx，返回的数据结构如下

{
"data":{
"tokenId":"AAA",
"access_key":"xxx-xxx",
"refresh":true
},
"msg":"",
"result":"ok"
}

• 当data/refresh值为true时，表示该令牌被刷新
• 当result不为ok时，说明发生系统级错误，相关错误码请参考这里

3.注销Token

通常不需要在第三方系统注销Token。注销Token后，该用户此刻在AWS门户或其他SSO集成系统中，对应的会话/令牌将失效。

服务请求地址

同验证Token

服务请求参数

请求处理结果

结果以json数据结构返回。假设要注销的tokenId为AAA，access_key为xxx-xxx，返回的数据结构如下

{
"data":{
"tokenId":"AAA",
"access_key":"xxx-xxx",
"close":true
},
"msg":"",
"result":"ok"
}

• 当data/close值为true时，表示该令牌已注销，该用户所有系统的登录状态均失效
• 当result不为ok时，说明发生系统级错误，相关错误码请参考这里