配置参数

在设置->用户与安全->SSO设置，填写配置信息：

填写完以上信息登录界面便会出现SSO单点登录

*配置参数说明：

配置参数	必填	说明	示例
重定向地址（Redirect_URL）	是	站点地址	https://sso.company.com
应用ID（App ID）	是	由企业生成提供	9d8a121ce581499d
应用密钥（App Secret）	是	由企业生成提供	698d59D8A1217b701668
适用范围（Scopes）	否	该参数可以了解企业自有 SSO 服务的相关文档
授权URL（Authorization URL）	是	该地址可以了解企业自有 SSO 服务的相关文档	https://sso.company.com/login/oauth/authorize
访问令牌URL（Access Token URL）	是	该地址可以了解企业自有 SSO 服务的相关文档	https://sso.company.com/login/oauth/access_token
用户信息URL（User Info URL）	是	该地址可以了解企业自有 SSO 服务的相关文档	https://sso.company.com/api/user

重定向地址（Redirect_URL）获取

业务流程

HTTP 请求过程
参考上方的”业务流程图“进行

第2步、用户浏览器从 helplook 站点跳转到企业 SSO 登录界面

跳转链接：https://sso.company.com/oauth/authorize?client_id=9d8a121ce581499d&redirect_uri=https%3A%2F%2Fcompany.helplook.com%2Faccess&response_type=code&scope=public

第4步、用户浏览器从企业 SSO 登录界面跳转到 helplook 授权回调界面

跳转链接：https://company.helplook.com/access?code=9e7d0a6dea2e12e99df0

第5.1步、helplook后台向 SSO 获取用户 Token

请求方式	请求地址
POST	https://sso.company.com/login/oauth/access_token

Body 类型 : application/json

参数	必填	说明	示例
client_id	是	应用ID	9d8a121ce581499d
client_secret	是	应用密钥	698d59D8A1217b701668
code	是	预授权码	9e7d0a6dea2e12e99df0
grant_type	是	授权类型	code

响应

{
    "access_token": "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",
    "token_type": "bearer",
    "scope": "",
    "expire_time": "7200" // 过期时间(秒), 不返回此参数, token默认为30天过期
}

第6步、helplook 通过 Token 从后台向企业 SSO 获取用户信息

请求方式	请求地址
GET	https://sso.company.com/api/user

Body 类型 : application/json

请求头： Authorization: Bearer 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

响应

{
	"nickname": "helplook",
	"open_id": 166786062,
	"avatar": "",
	"phone": "",
	"email": "",
    "auth_group_id": "",
}

参数	必填	说明	示例
nickname	是	昵称	helplook
open_id	是	企业自有系统用户唯一ID	166786062
avatar	否	头像
phone	否	手机号
email	否	邮箱
auth_group_id	否	分组ID(多个用，分割)	2,3

备注、业务异常响应格式

{
	"error": "无效的授权码",
	"error_description": "传递的授权码不正确或已过期",
	"error_uri ": ""
}

让用户直接跳转到 SSO 登录界面，登录成功后，跳转回期望访问的页面

http://company.helplook.com/access?back_to=/docs

http://company.helplook.com/access?back_to=http%3A%2F%2Fxx.helplook.com%2Faccess%3Fback_to%3D%2Fdocs

直接给用户返回一个已授权的链接，访问该链接时，会自动跳转到期望访问的页面

https://company.helplook.com/access?code=aaa-bbb-ccc&back_to=/docs

https://company.helplook.com/access?code=aaa-bbb-ccc&back_to=http%3A%2F%2Fxx.helplook.com%2Faccess%3Fback_to%3D%2Fdocs

FAQ

1. 站点开启授权访问，用户使用SSO授权登陆，导致AI问答小部件SDK，提示需要登陆怎么办？

答：使用SDK提供的js方法实现SSO登陆授权

<script type="text/javascript" id="helplook-sdk" src="https://sdk.helplook.net/pro/hlSdk.js?id={站点id}"></script>
<script>
        // code是通过后端请求获取的
        window.HelpLookSdk.ssoLogin('code')
</script>

HelpLook对接SSO单点登录配置实例参考

用户与安全API