[{"id":"cf9e6fa8-0b86-49e2-ac68-07594c7af412","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"d3324a01-b600-4674-8aee-dac1f6640ec9","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"3e247fcf-cdb2-4f60-a969-1498a5bfdb2d","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"f8fae864-8593-4474-a823-ae63aa34f17c","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"931caca9-ac3f-4fb9-bd21-c561b8f4c131","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"31b37c80-894c-4ddb-8445-0ddb77116ebf","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"7827c267-c18d-4225-a98a-69abc788f00d","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"75958fc3-b020-4620-a44c-34e00d53c6ab","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"8cdb3b7d-dca1-4490-bebc-d8faa2998eb4","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"94d72550-4999-4422-aaa0-0a149d42e4fd","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"087e3f2a-f18d-4838-a51d-1d98539c8b0f","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"0d8daadd-44fb-4e7d-bfae-d7e3c494fbdc","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"4100a562-8227-463d-8cd7-a86c028c7980","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"967ee563-9ecf-44e2-99a4-e91fe8dbc722","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"ad4c4887-a925-4aa3-a65c-6988bbc71603","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"282ed04c-5f92-4348-a82e-125448d5c70e","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"3ca1ce65-7f2e-4b1b-8846-361962f50ed0","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"e1fb1b27-6f94-4100-bb0e-7b43d63781eb","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"9a39e982-c66b-489e-b0e1-bfa1bcd15a70","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"274f82b6-deda-49dc-8487-95028b51195c","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"5c518362-9fbf-484c-80ef-72d2ec815c2d","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"53d6e6ad-c925-491c-9faa-0f374d8904e0","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"1d5eb6c4-41cd-4121-8273-c8555932ed35","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"7e47a724-c7be-464b-bf41-6c8844499cd1","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"207aa98c-0f41-4b44-95a5-cd18c154c79d","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"b033909b-d5a9-448e-9238-a044d0c6c062","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"9478d8b4-6bd7-4049-ad88-54593e69123c","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"beb379f4-f287-49b1-9c9b-a396e6c04a2d","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"3f2daab3-114b-41f3-916f-b2df9f377634","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"240b019b-37c2-4426-a9ca-d4e57d48ffec","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"6d91ce8c-1454-408b-b42a-f13ed34d7741","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"b947ca15-7493-455f-834b-f1bddb015cde","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"bca11f89-3090-45c9-8730-9d2bfe3d8533","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"8a50b408-80ee-443d-a2d6-ba6d4e0cff64","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"2928a65c-9eb7-4566-947d-dcd1b964242a","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"dac60248-5749-4548-96c1-5ac67b63dfba","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"30d4007d-ac66-497f-b333-92fbf155f379","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"7243b1bf-b870-4199-a0d9-accf339eaf9a","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"de71aa3e-78f6-412f-99eb-b89cde8a0cb7","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"1245bac8-b2d7-4bb7-a0d4-ca10152819f3","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"76f3c859-c392-44dc-af32-6003bfe33fe2","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"de23f283-0ab0-44f4-bb22-5a3771cd5366","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"8cde5af9-f36a-4bc2-a396-76735b77adfc","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"3ff57337-c9a3-4afe-971e-a2ffa073d412","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"395b26ec-782f-447c-b558-d565b399ac81","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"4690b659-1897-49d5-8743-adc5eb02d41f","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"b35f451b-a8e4-41ec-a686-a940d1c62271","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"041092ab-8521-4e42-9a41-094038252b05","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"6f87b8ff-da60-4307-af0a-8e73170cfc0c","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"cb06d0d4-32e7-4c71-a53a-9885cbe10ce5","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"36611fc3-508f-430b-a33b-86ffb4b2c1c9","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"e5514e63-4aaa-456c-9c76-b462ddc4a85c","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"9e8b8e90-de25-49a0-abb4-551bc5ea9e64","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"6678d138-580e-4b9b-b81f-55e328061d72","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"c14b681e-ebf8-4fdb-953d-ed9972772441","tags":[{"product":null,"links":null,"id":"ba7e818e-4f6b-4211-b1ac-58e3bafcf439","name":"\u66F4\u65B0","color":"orange","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]},{"id":"b270146e-438e-43ec-a233-c509042c9600","tags":[{"product":null,"links":null,"id":"adf72f47-7f61-4239-8392-b9bcc127fa80","name":"\u65B0\u589E","color":"green","productId":"0995490e-43fc-4d6e-bc8d-8e66f38b0c63"}]}]
产品官网 帮助文档 API 文档 视频教程 技术社区
在线Demo 免费试用
(Showing Draft Content)

用户同步

功能概述

当您由于各种原因无法通过安全提供程序或单点登录的方式集成Wyn系统时，Wyn提供用户同步的能力将第三方系统（如CRM,OA等）的用户数据，包括：用户，组织，角色，用户组织关系和用户角色关系，同步到Wyn系统中，同时支持定时更新，以实现既有系统和Wyn系统的用户信息统一。

type=info

请注意，用户同步功能仅可以在Wyn-8.0及以上版本使用。

功能简介

整个方案的原理是通过将原始业务系统的存储用户、组织、角色表的数据库（或者其他数据源）读取，然后通过Wyn的直连数据集建立原始业务系统数据库用户表字段到Wyn内置的用户表的中各个字段字段的映射（组织和角色类似），将用户、组织、角色等信息同步到Wyn系统内置的用户、组织、角色表中。

Wyn用户同步提供了以下内容：

  1. 同步范围：以下内容的一个或者多个

    1. 用户

    2. 组织

    3. 角色

    4. 用户-组织关系

    5. 用户-角色关系

  2. 手动同步或者配置定时同步

  3. 失败通知

  4. 查看同步历史

用户同步主要包括以下三个步骤:（以用户信息为例）

  1. 连接客户既有系统的用户数据 （创建数据源）

  2. 创建直连数据集，建立原始业务系统用户表字段和Wyn内置的用户表字段的映射关系

  3. 运行同步服务，将用户数据写入Wyn数据库

image

Wyn的用户同步采用的是全量同步的策略，具有以下特征：

  • 所有来自于同步用户功能的用户，组织和角色的提供者都是Synchronizer

  • 同步的用户数据不会影响其他来源的用户数据，比如UI创建，单点登录

  • 部分数据同步失败不会影响整体数据的同步

  • 同步的用户，组织，角色允许被修改，下一次同步时将根据id作为唯一标志，来进行不同的数据操作

  • 用户同步只会同步数据集结果集提供的数据，数据集结果集中没有提供的字段的对应属性将保持不变

下表可以清晰地描述连续两次同步之间的不同的数据条目涉及的数据操作（以id作为唯一标志）。

上次同步数据集

本次同步数据集

数据操作

包含

包含

更新

不包含

包含

新增

包含

不包含

删除

用户数据连接及建立字段映射

用户同步需要从数据源和数据集中获取客户既有系统的用户数据。

连接客户既有系统的用户数据

image

我们可以根据既有系统的用户数据存储介质选择数据源类型，Wyn支持的所有数据源类型都可以用于用户同步。

本文将以Excel数据源为例，为您提供一个完整的用户同步设置指南。当然，您也可以使用数据库系统来进行用户同步功能的体验。

用户同步.xlsx

您可以下载上面的Excel文件到本地查看结构和数据，并创建数据源。

image

使用直连数据集建立信息映射

由于既有系统的种类繁杂，来自于不同系统的用户数据存储格式不尽相同。因此，对于直连既有系统用户数据的数据源，我们必须要对其进行加工整合，以用于用户同步。

在使用数据源连接了既有系统的用户数据前提下，Wyn的用户同步功能要求使用直连数据集对数据进行加工。

同时，对于不同的同步内容，需要创建不同的直连数据集。您需要分别创建5个直连数据集来同步用户、组织、角色、用户与支持关系、用户与角色关系这5种不同的用户数据。

如下为用户数据集，用户可以勾选要同步的信息，同时需要在别名中按照下面《用户数据集》表格里的 “字段名” 输入到别名中，建立和Wyn系统中的用户表字段的映射，比如原始业务表的 username 字段同步到Wyn内置的name字段中。其他字段类似。


image

本章节后续内容将介绍用户同步直连数据集输出的数据字段要求。

type=info

请注意：用于用户同步的直连数据集必须满足以下各小节中表格所述的字段要求。比如部分字段是必填字段，不能为空。

用户数据集

字段名

是否必须

描述

约束

id

是

用户id

不能为空

name

是

用户名

不能为空

password

否

内置属性：用户密码

将会被用于明文密码，并按照Wyn加密方式进行存储。

更多有关同步密码的内容可以查阅密码同步与应用密钥章节

email

否

内置属性：用户邮箱


mobile

否

内置属性：手机号码


avatar

否

内置属性：头像

只支持URL，不支持二进制数据和base64格式的字符串

full_name

否

内置属性：用户全名


first_name

否

内置属性：用户姓氏


last_name

否

内置属性：用户名字


enabled

否

内置属性：用户禁用状态


xxx

否

用户扩展属性

字段名需要与用户扩展属性设置保持一致，字段类型建议设置为字符串

用户扩展属性

用户同步支持同步用户扩展属性。我们需要在用户数据集中输出用于同步用户扩展属性的字段，字段名应该与用户扩展属性名保持一致，为了避免格式问题，字段类型建议设置为字符串。

用户扩展属性同步有两种特殊情况：

  1. 对于多值的用户扩展属性，数据集的对应字段输出值应该以逗号分隔。用户同步在处理允许多值的用户扩展属性时，会自动将逗号分隔的值分割成多个值进行同步。

  2. 当用户扩展属性没有创建，而用户数据集中提供了一个对应的字段时，用户同步结果中会出现警告“用户扩展属性未创建”，该警告不影响用户的同步。

组织数据集

字段名

是否必须

描述

约束

id

是

内置属性：组织id

不能为空

parent_id

是

内置属性：父组织id；

为空时表示父组织设置为全局组织。

父组织id不能指定为其他来源的组织的id，全局组织除外

name

是

内置属性：组织名

不能为空

xxx

否

组织模型属性

字段名需要与组织模型属性设置保持一致，字段类型建议设置为字符串

组织模型属性

用户同步支持同步组织模型属性。我们需要在组织数据集中输出用于同步组织模型属性的字段，字段名应该与组织模型属性保持一致，为了避免格式问题，字段类型建议设置为字符串。

组织模型属性同样也有两种特殊情况：

  1. 对于多值的组织模型属性，数据集的对应字段输出值应该以逗号分隔。用户同步在处理允许多值的组织模型属性时，会自动将逗号分隔的值分隔成多个值进行同步。

  2. 当组织模型属性没有创建，而组织数据集中输出了一个对应的字段时，用户同步结果中会出现警告”组织模型属性未创建“，该警告不影响组织的同步。

角色数据集

字段名

是否必须

描述

约束

id

是

角色id

不能为空

name

是

角色名

不能为空

org_id

是

角色所属组织id

为空表示全局组织

角色所属组织id不能指定为其他来源的组织id，全局组织除外

用户-组织关系数据集

字段名

是否必须

描述

约束

user_id

是

用户id

不能为空

org_id

是

用户所属的组织id；

为空时表示全局组织

用户所属组织id值不能为其他来源的组织id，全局组织除外

is_admin

否

是否要指定该用户为所属组织的组织管理员；

默认：否

字段类型必须是布尔类型

用户-角色关系数据集

字段名

是否必须

描述

约束

user_id

是

用户id

不能为空

role_id

是

用户所属角色id

不能为空

按照上述字段要求创建对应的同步数据集后，就可以进入用户同步的配置阶段。


用户同步配置

在管理门户>账户管理>同步设置，我们可以进行用户同步设置。

同步设置主要包括以下几个方面：

  • 开启/关闭

  • 同步数据集设置

  • 调度设置

  • 超时设置

  • 失败通知设置

开启/关闭

image

选择数据集

选择要同步的类型，按照自己的同步需求，

image

同时在下拉框选择上述章节中创建的数据集。

image

指定完同步数据集后，点击保存更改时，会进行数据集字段校验。如果数据集字段校验失败，UI会明确提示校验失败的数据集及校验失败的具体字段。

接下来，我们可以通过手动同步的方式触发用户同步任务，或者开启用户同步的自动调度。

调度设置与手动同步

手动同步

不开启自动同步时，可以通过手动同步按钮触发用户同步。

image

点击手动同步按钮后，右侧工作区会轮询用户同步任务的状态，当用户同步完成以后，右侧工作区会显示本次同步的结果。

image

此时，可以查看组织，角色和用户管理，查看同步成功的组织，角色，用户及其之间的关系。

同步任务的状态分为三种：

  1. 失败

  2. 警告

  3. 成功

同步任务失败，所有数据都同步失败；

警告状态下，部分数据同步成功，同步失败的数据条目包括失败和警告两种类型，在任务结果中可以查看和过滤；

成功状态时，所有用户数据同步成功。

调度设置

用户同步也可以进行自动调度的设置，用户同步的调度设置，在功能上和Wyn的其他任务类型一致。

开启自动同步设置以后可以，可以配置详细运行计划。

image

配置完定时同步以后，点击保存更改按钮，右侧工作区将会显示下次用户同步任务的执行时间。

image

通过设置合理的定时同步间隔，我们能够在既有系统用户数据更新以后，保证Wyn与既有系统的用户数据始终保持一致。

type=info

由于用户同步的日志量较大，建议生产环境中不要将同步频率设置太高。

超时设置

image

超时设置的最小值可以为1分钟；超过超时设置的时限，同步任务仍然没有完成将直接失败，并不会同步任何数据。

失败通知

在上面的章节中，我们曾提及，在用户同步过程中，部分数据失败不会影响其他数据的同步。

当同步任务出现部分数据失败或警告的条目时，通过失败通知，我们可以获取用户同步任务的最新状态。

失败通知的可选渠道将包含Wyn通知中心配置完成的除API以外的所有渠道。

image

type=warning

失败通知渠道需要在通知中心配置成功以后才会显示，

通知发送失败不会影响同步任务的状态。

image

失败通知的内容包含以下内容：

  1. 同步时间

  2. 用户同步成功，失败和警告的数目

  3. 组织同步成功，失败和警告的数目

  4. 角色同步成功，失败和警告的数目

  5. 用户与角色关系同步成功，失败和警告的数目

  6. 用户与组织关系同步成功，失败和警告的数目

具体失败条目及失败原因不包含在通知内容中，失败通知示例如下：

image

密码同步与应用密钥

由于各个业务系统对于密码的加密策略不同，一般来说，既有系统用户数据库表中的密码字段，存储的并非是系统用户的密码明文，而是加密以后的密码密文；同时，加密密码的算法一般是单向不可逆的，即便是可逆的加密算法，从安全性的角度考虑，任何软件系统都是不允许其密码加密算法流出系统的。Wyn在同步密码时，仅支持将用户同步数据集的密码字段值作为密码明文进行同步。

这意味着，由于密码字段加密的原因，直接使用既有系统用户数据库中加密的密码字段用于同步会导致既有系统的密码和Wyn的密码不一致。

当然，如果我们知道明文密码，可以在用户同步数据集中输出密码字段以用于同步。

当然，在无法同步密码明文时，为了降低集成难度，Wyn提供了应用密钥的方案，您可以查阅应用密钥章节获取详细信息。

应用密钥

如果无法直接密码明文进行密码同步，Wyn提供应用密钥来解决集成的问题。

应用密钥是一个应用级别的安全密钥

  • 只能被同步的用户使用的

  • 只能用于生成令牌

  • 不能用于登录

所有的同步用户，无论是否具有密码，都可以使用应用密钥生成令牌；其他来源的用户不能使用应用密钥生成令牌。

type=info

Wyn的应用密钥是专门针对集成场景的一种解决方案，请确保应用密钥不被泄露，同时建议定期更新应用密钥。

image

接下来，我们通过API使用应用密钥和同步的用户来生成令牌

image

type=info

更改应用密钥不会影响之前生成的token的有效性

常见错误

错误码

错误信息

错误等级

描述

0001

id为空

错误


0002

名称为空

错误


0003

检测到id重复

错误


0004

检测到名称重复

错误


0005

检测无效的名称

错误


0011

实体不存在

错误


0021

用户扩展属性/组织模型属性不存在

警告


0022

无效的用户扩展属性/组织模型属性值

警告


0023

无效的电子邮箱

警告


0024

无效的头像值

警告

头像值只支持URL

0031

检测到组织形成环

错误


0032

组织没有连接到组织树中

错误


0041

权限冲突，不满足权限范围的限制

严重错误

整个同步任务失败

0098

任务被取消或超时

严重错误

整个同步任务失败

0099

未知错误

严重错误


1001

无效的用户同步设置

错误

用户同步不会自动调度

1002

至少指定一个数据集

错误

用户同步不会自动调度

1003

用户同步自动调度失败

严重错误

用户同步不会自动调度

1004

数据集字段校验失败

严重错误

用户同步不会自动调度

1005

用户同步超时

严重错误


1006

获取数据集结果集失败

严重错误


上表中，严重错误将导致所有用户数据都同步失败；错误会导致单条用户数据同步失败；警告导致该属性同步失败，而不导致单条用户数据失败。