钉钉集成
钉钉集成支持同步钉钉通讯录到站点的用户管理,同时支持钉钉的单点登录、消息通知。本文介绍通过钉钉登录修改云效的相关功能。
适用版本 | 专属版 |
前提条件
服务器出口 IP:需提供企业实例的对外IP地址(专属版用户请联系技术支持获取)。
流程概览
钉钉集成配置
步骤一 创建钉钉集成
站点管理员可以在
创建钉钉集成。如果需要创建不在钉钉同步范围的用户,可以勾选支持内建用户,以创建同步范围外的用户。步骤二 创建钉钉应用
需要在钉钉开放平台上创建企业内部应用,可参考查看如何创建内部应用。也可按照下方提示填写创建企业内部应用表单信息,然后单击确定创建,需注意:
应用类型:选择小程序。
开发方式:选择企业自主开发。
应用图标:使用云效官方图标
其次,在左侧导航栏选择开发管理,填写服务器出口 IP。
在左侧导航栏选择应用信息,记录关键凭证:
Corpid(企业ID)
AppKey/AppSecret
AgentId
将上一步的信息填写到云效下图的表单中,填写完成后单击下一步。
步骤三 配置应用权限
云效需要获取钉钉的相应权限,才能够同步钉钉通讯录、通过钉钉登录或推送钉钉消息通知,所需权限如下图所示。 进入钉钉开放平台,在步骤一中已创建的组织内部
中配置权限,如果需要限制钉钉通讯录同步的用户范围,请配置权限范围。在钉钉开放平台配置完成后,回到云效钉钉集成配置页面,单击下一步。
步骤四 账号绑定和属性映射
账号绑定方式:自动绑定邮箱相同的用户,云效将按照同步策略,自动将云效上、钉钉组织中邮箱账号相同的用户绑定在一起。
云效将按照下图中字段映射关系,自动将钉钉的用户信息与云效中的用户信息,按照同步策略进行映射同步,目前暂不支持修改字段映射关系,确认后单击下一步。
步骤五 开启功能服务
目前提供四种功能服务:在配置过程中默认关闭。如果在未开启功能的情况下保存钉钉集成配置,后续可以在钉钉集成详情页面中开启相应的功能服务。
用户和组织同步:启用后,云效用户管理与钉钉通讯录保持同步,请确认钉钉应用的可见权限范围。
单点登录:启用后,可在云效登录页面快速跳转至钉钉登录,通过钉钉访问云效。
消息通知:启用后,支持钉钉消息通知,云效内的消息订阅功能可通知用户。
钉钉工作台访问云效:启用后,可在钉钉工作台直接打开云效网页。
当完成所有配置后,单击保存配置按钮即可完成钉钉集成的配置,该服务配置后续可进行修改。
功能使用说明
用户组织同步策略
开启钉钉的用户和组织同步
当云效上未开启其他第三方的用户和组织同步功能时,可以配置钉钉的用户和组织同步,支持配置同步时机、用户差异处理、组织差异处理的规则。
场景选项 | 影响结果 |
场景选项 | 影响结果 |
数据同步时机 |
手动同步建议每次操作间隔 1 个小时以上。 |
用户差异处理:默认忽略云效中多余的账号,并为同步范围内的钉钉账号创建并绑定云效账号。 | 已有云效账号未匹配到钉钉账号:
|
已有钉钉账号未匹配到云效账号:
| |
组织差异处理:默认忽略云效中多余的部门节点,并为同步范围内的钉钉部门节点创建并绑定云效部门。 | 已有云效部门未匹配到钉钉部门:
|
已有钉钉部门未匹配到云效部门:
|
查看用户和组织同步结果
在开启用户和组织同步的情况下,打开钉钉集成详情页面,可以查看最新同步结果:未执行同步、同步成功、同步失败、部分同步成功。
当同步过程中发生了同步失败情况,可参考钉钉开放平台API 调用错误码,排查同步失败的原因。
单点登录配置
开启单点登录
打开单点登录的开关后,需要将云效的回调地址配置在第一步创建的钉钉应用的
的输入框,即可完成钉钉单点登录的配置。通过钉钉登录云效
开启单点登录后,云效登录页面将显示钉钉登录入口,点击后可进入钉钉登录页面,已绑定钉钉账号的用户可以通过钉钉登录云效。
开启消息通知
在开启用户和组织同步或单点登录的情况下,可开启钉钉的消息通知功能,同时需要完善钉钉应用中的机器人配置信息。
钉钉工作台访问配置
如果需要通过钉钉 PC 客户端的工作台访问云效,可打开钉钉工作台访问云效的开关,同时将云效网页地址粘贴到第一步创建的钉钉应用的
的输入框中。功能的修改与移除
功能修改/关闭
在钉钉集成详情页中,如果开启了某个功能服务,可以看到修改服务配置的按钮,点击后即可进行相关功能服务配置的修改或者关闭该功能。
修改服务:可按需调整。
关闭服务:功能使用会有影响,具体请参见下表。
功能
影响结果
功能
影响结果
用户和组织同步
不解除云效账号与钉钉账号的绑定关系。
不再执行钉钉通讯录的用户和组织同步。
单点登录
不会解除云效账号与钉钉账号的绑定关系。
不支持通过钉钉账号登录云效,用户若需要登录云效,可使用云效的登录账号和密码进行登录。
消息通知
如果同时关闭了用户和组织同步、单点登录功能,将关闭消息通知功能。
关闭后,不会再通过钉钉给用户发送消息通知。
钉钉工作台访问云效
不支持通过钉钉 PC 端工作台直接访问云效。
移除钉钉集成
在钉钉集成详情页中,可单击移除集成按钮,二次确认后即可移除钉钉集成,移除集成后:
解除云效账号和钉钉账号的绑定关系,不会影响已同步的用户和组织架构信息。
不支持接收钉钉消息通知。
不支持通过钉钉登录云效,用户若需要登录云效,可使用云效的登录账号和密码进行登录。
- 本页导读
- 前提条件
- 流程概览
- 钉钉集成配置
- 步骤一 创建钉钉集成
- 步骤二 创建钉钉应用
- 步骤三 配置应用权限
- 步骤四 账号绑定和属性映射
- 步骤五 开启功能服务
- 功能使用说明
- 用户组织同步策略
- 单点登录配置
- 开启消息通知
- 钉钉工作台访问配置
- 功能的修改与移除
- 功能修改/关闭
- 移除钉钉集成