钉钉
# 钉钉插件配置手册
# 1. 钉钉下游数据同步
钉钉作为下游数据源,把SS0360中组织&用户等数据同步到钉钉管理后台
# 1. 前置条件
你必须在钉钉开发者后台,创建应用,才能进行数据同步联通配置等操作
注意事项:
- 从钉钉开放平台:https://open.dingtalk.com/进入开发者后台,选择对应的企业进入
- 进入应用开发的企业内部开发
- 创建企业自主开发的H5微应用、
- 进去应用就能获取到对应的appKey,appSecret
- 在该应用的权限管理中赋予相应的权限
# 2. 新建钉钉应用
- 管理员登录SSO360平台,【后台管理】-->【应用管理】-->【应用中心】-->【新增应用】
appKey——钉钉平台中获取appKey
appSecret——钉钉平台中添加应有的appSecret
- 开启注册回调(必须)
钉钉回调配置参考文档:第三方下游回调(钉钉-用户加入组织回调) (opens new window)
填写应用对应的参数和同步参数,然后点击”测试连通“按钮,确保应用连通成功。
填写VerificationToken,EncryptKey(自行填写,也可以使用钉钉上生成的数值)并保存。
- 钉钉回调配置
VerificationToken——钉钉应用详情中事件订阅模块的“签名 token”
EncryptKey——钉钉应用详情中事件订阅模块的“加密aes_key”
事件订阅请求地址——复制并填写到钉钉应用详情中事件订阅模块的“请求网址”处
对应关系如上图所示
点击保存,保存会出发一个check_url的事件,回调到sync服务中,如果连通成功。则会在下方出现可勾选的事件订阅列表。
勾选【通讯录用户增加】事件订阅。
# 3. 添加应用属性
说明:每个插件都会自动内置部分必需属性(内置的属性请勿删除),如果您的插件没有自定义属性,则无需添加,您可以跳过此步骤。
在【应用中心>应用详情>属性池】模块添加更多的应用同步的映射属性
自定义钉钉通讯录属性
如果你想同步某些新加的自定义属性(例如工作地点_locationid),可以在通讯录信息模块,添加自定义字段
注意事项:
- 钉钉应用详情中添加的自定义属性必须为钉钉API接口中支持且SSO360中支持同步的属性
# 4. 创建同步任务
在【应用管理】>【同步任务】模块,创建下游钉钉同步任务,任务配置信息如下:
1)用户属性映射
SSO360字段名称 | SSO360字段 | 是否必填 | 上游数据格式 | 钉钉字段名称 | 自定义字段数据类型 | 钉钉字段 |
---|---|---|---|---|---|---|
用户名 | username | 是 | 用户名 | name | ||
手机号 | phone | 是 | 手机号 | mobile | ||
邮箱 | 否 | 邮箱 | ||||
工号(自定义) | jobnumber | 否 | 工号 | jobNumber | ||
职位(自定义) | jobposition | 否 | 职位 | title | ||
入职日期(自定义) | entrydate | 否 | DATE:时间字符串 | 入职日期 | INT(时间戳) | hiredDate |
办公地点(自定义) | businessadress | 否 | 办公地点 | workPlace |
2)组织属性映射
SSO360字段名称 | 自定义字段数据类型 | SSO360字段 | 是否必填 | 钉钉字段名称 | 钉钉字段 |
---|---|---|---|---|---|
组织名称 | orgName | 是 | 组织名称 | name |
# 5. 应用授权
**注意事项:**如果某些用户没有授权该应用,则这些应用将无法同步到下游
给要同步的用户添加钉钉应用权限
添加方式有两种:
1)直接给用户添加钉钉应用权限,在用户列表中,搜索到该用户,进入用户详情
2)给用户所关联的组织添加钉钉应用权限,在【应用授权】模块批量给组织授权
# 6. 进行数据同步
在同步任务模块,找到钉钉同步任务,点击页面同步功能按钮
1)增量同步
a、新增用户或组织同步
新创建的用户(用户分类和根组织满足同步任务配置),必须加入有钉钉应用权限的组织,进行增量同步时,才能同步成功。
新创建的组织(组织分类为默认分类,根组织满足同步任务配置),不用管是否有钉钉应用权限,进行增量同步时,组织都能同步成功。
b、修改或删除用户或组织同步
修改或删除用户时(用户分类和根组织满足同步任务配置),用户有钉钉的应用权限,进行增量同步时,才能同步成功。
修改或删除组织时(组织分类为默认分类,根组织满足同步任务配置),不用管是否有钉钉应用权限,进行增量同步时,组织都能同步成功。
2)全量同步
新增或修改或删除用户时(用户分类和根组织满足同步任务配置),用户有钉钉应用权限,进行全量同步时,才能同步成功。
新增或修改或删除组织时(组织分类为默认分类,根组织满足同步任务配置),不用管是否有钉钉应用权限,进行全量同步时,都能同步成功。
注意事项:
因SSO360同步用户数据至钉钉时,用户会接收到邀请,同意后才能加入钉钉,在配置测试联通信息时必须配置回调保证SSO360与钉钉数据同步关联成功
属性映射中配置status状态字段则用户启用/禁用后同步至钉钉时用户状态生效;不配置,不生效
钉钉支持用户多组织
钉钉中职级属性需要手动在钉钉后台添加扩展属性
钉钉不支持将直属主管设为用户自己,接口会报错:无法设置为直接主管,当前员工是该主管的上级
SSO360新增禁用用户(用户具有钉钉应用权限),执行增量/全量同步时,钉钉下游会新增一个用户
# 7. 验证同步结果
同步完成后,使用你的管理员账号,去钉钉后台查看并验证同步数据结果,后台地址:https://oa.dingtalk.com/