钉钉集成

第三方集成中的钉钉集成，支持同步钉钉通讯录到云效企业的用户管理，同时支持钉钉的单点登录、消息通知。

企业管理员可以在 企业管理-第三方集成 中配置和管理钉钉集成。如果需要创建不在钉钉同步范围的用户，可以勾选支持内建用户，可以创建同步范围外的用户。

配置钉钉集成信息

第一步 配置企业内部应用

首先，需要在钉钉开放平台上创建企业内部云效应用，可参考查看如何创建内部应用，可按照下方提示填写创建企业内部应用表单信息（云效应用图标可在下方附件中下载），然后单击确定创建，需要注意：

• 应用类型：选择小程序
• 开发方式：选择企业自主开发

其次，需要填写服务器出口 IP，否则无法正常使用；

当应用创建好后将可以得到钉钉应用相关应用凭证，同时可以在开放平台首页看到 Corpid，将这些信息复制后填写至配置企业内部应用的表单中。

企业内部应用中的信息都填写完成后，单击下一步。

第二步 配置应用权限

云效需要获取钉钉的相应权限，才能够同步钉钉通讯录、通过钉钉登录、或推送钉钉消息通知，所需权限如下图所示。 进入钉钉开放平台，在第一步中已创建的企业内部应用详情页面-权限管理中配置权限，如果需要限制钉钉通讯录同步的用户范围，请配置权限范围。

在钉钉开放平台配置完成后，回到云效钉钉集成配置页面，单击下一步。

第三步 账号绑定和属性映射

目前提供种账号绑定方式：自动绑定邮箱相同的用户，云效将按照同步策略，自动将云效上、钉钉组织中邮箱账号相同的用户绑定在一起。

云效将按照下图中字段映射关系，自动将钉钉的用户信息与云效中的用户信息，按照同步策略进行映射同步，目前暂不支持修改字段映射关系，确认后单击下一步。

第四步 开启钉钉集成的功能服务

目前提供 4 种功能服务：

• 用户和组织同步：开启后，可保持云效用户管理中的用户目录和钉钉通讯录的同步，建议确认钉钉应用可见权限范围;
• 单点登录：开启后，在云效登录页面中即可快速跳转钉钉登录页面，通过钉钉登录云效;
• 消息通知：开启后，可支持钉钉消息通知，云效上有消息订阅功能的产品内消息均可触达用户;
• 钉钉工作台访问云效：开启后，可在钉钉工作台中直接打开云效网页。

以上 4 种功能服务在配置过程中默认不开启，如果不开启功能的情况下保存钉钉集成配置，后续可以在钉钉集成详情页面中开启对应的功能服务。

如果选择开启对应的功能情况下，需要进行相关配置（以下内容适配于修改对应功能配置）。

开启钉钉的用户和组织同步

当云效上未开启其他第三方的用户和组织同步功能时，可以配置钉钉的用户和组织同步，支持配置同步时机、用户差异处理、组织差异处理的规则。

• 数据同步时机：默认为手动同步，并支持手动同步、定时同步的切换；
  • 手动同步：需要企业管理员在有数据变更后，手动在钉钉集成详情页面单击执行手动同步按钮完成用户和组织同步。

    提示：每次手动同步操作尽量间隔 1 个小时。

  • 定时同步：配置同步的时机和规则按每天（某刻）、每周（某天某刻）、每月（某天某刻）、每隔一定时间进行同步，如果设置为定时同步，建议保存配置后完成一次手动同步，以保证数据可以及时同步至云效。
• 用户差异处理：默认忽略云效上多余的账号且为在同步范围内的钉钉账号创建云效账号并绑定，可根据诉求修改；
  • 已有云效账号未匹配到钉钉账号-忽略：当已有云效账号未匹配到钉钉账号时，不删除云效上的多余账号；
  • 已有云效账号未匹配到钉钉账号-删除云效账号：当已有云效账号未匹配到钉钉账号时，删除云效上的账号；
  • 已有钉钉账号未匹配到云效账号-忽略：当已有钉钉账号未匹配到云效账号时，不在云效上创建新账号；
  • 已有钉钉账号未匹配到云效账号-新建云效账号并绑定：当已有钉钉账号未匹配到云效账号时，会按照账号绑定和属性映射规则在云效上创建新账号，并与钉钉账号绑定；
• 组织差异处理：默认忽略云效上多余的部门节点且为在同步范围内的钉钉部门节点创建云效部门并绑定，可根据诉求修改；
  • 已有云效部门未匹配到钉钉部门-忽略：当已有云效部门未匹配到钉钉部门时，不删除云效上的部门节点；
  • 已有云效部门未匹配到钉钉部门-删除云效部门：当已有云效部门未匹配到钉钉部门时，删除云效上的部门节点；
  • 已有钉钉部门未匹配到云效部门-忽略：当已有钉钉部门未匹配到云效部门时，不在云效上创建部门节点；
  • 已有钉钉部门未匹配到云效部门-创建云效部门并绑定：当已有钉钉部门未匹配到云效部门时，会在云效上创建部门节点，并将两方部门节点进行绑定；

开启单点登录

打开单点登录的开关后，需要将云效的回调地址配置在第一步创建的钉钉应用的应用详情-安全设置-重定向 URL 的输入框，即可完成钉钉单点登录的配置。

开启消息通知

在开启用户和组织同步或单点登录的情况下，可开启钉钉的消息通知功能，同时需要完善钉钉应用中的机器人配置信息（云效应用图标可在下方附件中下载），后即可在钉钉上接收云效推送的消息通知。

开启钉钉工作台访问云效

如果需要通过钉钉 PC 客户端的工作台访问云效，可打开钉钉工作台访问云效的开关，同时将云效网页地址粘贴到第一步创建的钉钉应用的应用详情-开发管理-PC 端首页地址的输入框中。

当完成所有配置后，单击保存配置按钮即可完成钉钉集成的配置。

通过钉钉登录云效

开启单点登录后，云效登录页面将显示钉钉登录入口，点击后可进入钉钉登录页面，已绑定钉钉账号的用户可以通过钉钉登录云效。

查看用户和组织同步结果

在开启用户和组织同步的情况下，打开钉钉集成详情页面，可以查看最新同步结果：未执行同步、同步成功、同步失败、部分同步成功。

备注：当同步过程中发生了同步失败情况，可参考钉钉开放平台 API 调用错误码，进行同步失败的原因排查。

修改/关闭钉钉集成的功能服务

在钉钉集成详情页中，如果开启了某个功能服务，可以看到修改服务配置的按钮，点击后即可进行相关功能服务配置的修改或者关闭该功能：

• 关闭用户和组织同步：
  • 不解除云效账号与钉钉账号的绑定关系;
  • 不再执行钉钉通讯录的用户和组织同步。
• 关闭单点登录：
  • 不会解除云效账号与钉钉账号的绑定关系；
  • 不支持通过钉钉账号登录云效，用户若需要登录云效，可使用云效的登录账号和密码进行登录。
• 关闭消息通知：
  • 如果同时关闭了用户和组织同步、单点登录功能，将关闭消息通知功能；
  • 关闭后，不会再通过钉钉给用户发送消息通知。
• 关闭钉钉工作台访问云效：
  • 不支持通过钉钉 PC 端工作台直接访问云效。

移除钉钉集成

在钉钉集成详情页中，可单击移除集成按钮，二次确认后即可移除钉钉集成，移除集成后：

• 解除云效账号和钉钉账号的绑定关系，不会影响已同步的用户和组织架构信息；
• 不支持接收钉钉消息通知；
• 不支持通过钉钉登录云效，用户若需要登录云效，可使用云效的登录账号和密码进行登录。

附件 云效应用图标