简道云
# 简道云插件配置手册
# 1. 单点登录配置
# 1 SP元数据准备
# 获取SP元数据文件
使用管理员账号登录简道云,点击【企业管理】(登录地址:https://www.jiandaoyun.com/signin)
【企业信息】-->【高级设置】,打开单点登录的开关,点击【配置】
任意填写,【保存】(后面会讲解如何配置)
下载SP元数据文件
# 2 IDP元数据准备
# 获取IdP证书
访问[http|https]😕/{idaas_host}/api/sso/protocol/saml2/idp/metadata,复制红框内容
使用工具 (opens new window),格式化证书,复制【X.509 cert with header】的内容
# 3 IDAAS配置
# 添加简道云应用
管理员登录IDAAS【后台管理】-->【应用管理】-->【应用中心】-->【新增应用】
集成应用中找到简道云,【添加应用】
认证发起方选择【从应用发起认证】,上传SP的元数据文件,应用地址填写【实体ID】的值,应用登陆属性选择【username】,对应SSO360登陆属性选择【jiandaoyunID】,如果该应用需要二次认证,可以勾选【登陆应用二次认证】,【保存】
# 应用授权
【后台管理】-->【用户服务管理】-->【用户管理】,查找用户后,点击【查看详情】
【应用信息】-->【添加应用】
勾选【简道云】,【确定】
# 4 简道云配置
# 配置单点登录
SAML2.0 Endpoint:填写格式为[http|https]😕/{idaas_host}/api/sso/protocol/saml2/idp/redirect/profile
IdP公钥:填写IdP生成的证书内容,详见1.2.1 获取IdP证书
SAML加密算法:SHA-256
Issuer URL:填写IdP的entityID
IdP的entityID从此处获取
# 绑定IdP与SP的用户
【通讯录】
【邀请成员】
【编号】填写IdP的用户手机号或邮箱,【邀请】
# 用户接受邀请
用户手机短信或邮箱收到邀请通知,按提示操作即可
# 获取简道云用户编号
点击用户名
复制【编号】
管理员登录IDAAS,【后台管理】-->【用户服务管理】-->【用户管理】,找到用户,【查看详情】
打开【用户属性】,简道云ID填写简道云用户的【编号】,【保存】
# 5 单点登录验证
# 验证方式
通过IDAAS用户中心点击简道云应用
# 验证结果
# 2. 数据同步配置
# 1 新建简道云应用
管理员登录SSO360平台,【后台管理】-->【应用管理】-->【应用中心】-->【新增应用】
- appKey——简道云平台中添加一个应用
填写应用对应的参数和同步参数,然后点击”测试连通“按钮,确保应用连通成功。
# 2 添加应用属性
说明:每个插件都会自动内置部分必需属性(内置的属性请勿删除),如果您的插件没有自定义属性,则无需添加,您可以跳过此步骤。
在【应用中心>应用详情>属性池】模块添加更多的应用同步的映射属性
# 3 创建同步任务
在【应用管理】>【同步任务】模块,创建下游简道云同步任务,任务配置信息如下:
1)用户属性映射
简道云字段名称 | 简道云字段 | 是否必填 | 上游数据格式 | SSO360字段名称 | 自定义字段数据类型 | SSO360字段 |
---|---|---|---|---|---|---|
成员编号 | username | 是 | STRING | 手机号 | STRING | phone |
昵称 | name | 是 | STRING | 用户名 | STRING | username |
注意事项:
暂不支持用户修改。
接口文档中只支持【昵称】入参。
因简道云查询接口,返回值不支持手机号、邮箱(业务上唯一约束)字段,所以无法使用回收功能进行回收。
因单点登录使用手机号作为用户编号,所以同步时使用idaas的手机号对应简道云的用户编号。
2)组织属性映射
SSO360字段名称 | 自定义字段数据类型 | SSO360字段 | 是否必填 | 简道云字段名称 | 简道云字段 |
---|---|---|---|---|---|
组织名称 | STRING | orgName | 是 | 组织名 | name |
注意事项:
暂不支持组织修改
接口文档中只支持【组织名称】入参
# 4 应用授权
给要同步的用户添加简道云应用权限
添加方式有两种:
1)直接给用户添加简道云应用权限,在用户列表中,搜索到该用户,进入用户详情进行授权
【后台管理】-->【用户服务管理】-->【用户管理】,查找用户后,点击【查看详情】
【应用信息】-->【添加应用】
勾选【简道云】,【确定】
2)给用户所关联的组织添加简道云应用权限,在【应用授权】模块批量给组织授权
说明:如果某些用户没有授权该应用,则这些应用将无法同步到下游
# 5 进行数据同步
# 1)增量同步
a、新增用户或组织同步
新创建的用户(用户分类和根组织满足同步任务配置),必须关联有简道云应用权限的组织,进行增量同步时,才能同步成功。
新创建的组织(组织分类为默认分类,根组织满足同步任务配置),不用管是否有简道云应用权限,进行增量同步时,都能同步成功。
b、修改或删除用户或组织同步
修改或删除用户时(用户分类和根组织满足同步任务配置),用户有简道云应用权限,进行增量同步时,才能同步成功。
修改或删除组织时(组织分类为默认分类,根组织满足同步任务配置),不用管是否有简道云应用权限,进行增量同步时,都能同步成功。
# 2)全量同步
新增或修改或删除用户(用户分类和根组织满足同步任务配置),用户有简道云应用权限,进行全量同步时,才能同步成功。
新增或修改或删除组织(组织分类为默认分类,根组织满足同步任务配置),不用管是否有简道云应用权限,进行全量同步时,都能同步成功。
注意事项:
目前不支持idaas上修改用户和组织信息同步到简道云,故增量同步idaas上修改用户和组织信息的数据到简道云,和全量同步非首次同步到简道云上的用户和组织时,此部分数据会同步失败报错“简道云不支持更新操作”
在idaas上新增禁用用户同步到简道云,会先在简道云上新增用户,再删除此用户
简道云接口调用频次为5次/秒,超过会报“API请求次数达到频率上限”,目前同步简道云接口调用间隔设置为了300ms
同步到简道云的用户若找不到父组织会同步到“全部成员”中,同步到简道云的组织若找不到父组织会同步失败报“父部门不存在”
# 6 验证同步结果
使用你的简道云管理员账号,去简道云后台查看并验证同步数据结果