用户信息对外API

用户信息对外api描述SID向应用提供的标准接口，以便外部应用调用。标准接口如下：

一、用户查询

二、用户查询(授权过滤)

三、用户同步

四、用户同步(授权过滤)

五、用户增加（1.9版本）

六、用户删除（1.9版本）

七、用户修改（1.9版本）

八、更新用户组织岗位关系（1.9版本）

九、根据组织code获取部门下所有用户

十、微哨在用接口-应用同步用户信息

十一、微哨在用接口-根据账号查询用户信息

十二、微哨在用接口-增量同步用户

十三、查询单个用户绑定的openId和unionId信息

十四、全量/增量查询用户绑定的第三方认证信息

十五、根据账号/身份证号查找用户多身份信息

十六、根据账号判断身份有效性

十七、获取用户身份信息二维码

错误代码映射表

字典码值映射

一、用户查询

根据账号获取身份平台用户信息

说明：需要进行用户数据授权

请求⽅式： GET（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/userInfo/{userId}

注：https方式类似。

请求参数：

userId:  账号

参数说明：

参数 类型 是否必须 说明
userId String 是 账号。

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
        "SFZJYXQ": 1630566048964,
        "MZM": "汉族",
        "ZHZT": "正常",
        "IDCARD": "98754324565755435",
        "SFYXQJZ": 1632985264990,
        "JXRYZT": "在职",
        "ZZMM": "xx",
        "GATQWM": "xx",
        "CYM": "cengyongming",
        "XMPY": "yongliyi",
        "RZHINY": 1612162861804,
        "USERID": "30008",
        "orgInfo": [
            {
                "org": [
                    {
                        "title": 组织",
                        "key": "RJDZZZ",
                        "isLeaf": true,
                    }
                ],
                "gangwei": [
                    {
                        "title": "a",
                        "key": "R608636ffd8f7ed0006f145ae",
                        "isLeaf": true,
                    }
                ]
            }
        ],
        "objectId": "613069b83012b40006edb0ee",
        "GH": "30008",
        "GJ": "中国",
        "SFYXQQS": 1630566070491,
        "RYZT": "正常",
        "XB": "男性",
        "HYZKM": "未婚",
        "JKZKM": "健康或良好",
        "CSRQ": 1630479623278,
        "SFZJLXM": "护照",
        "SFLBDM": "员工",
        "LXDH": "0102325465",
        "XM": "用例1",
        "TEL": "18547212068",
        "personId": "612f2fdbbaa4d50006a1e98c",
        "XYZJM": "",
        "SFLBMC": "员工",
        "LASTCHANGEPASSWORDTIME": "2021-06-30T16:00:00.000+0000"
    }
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
GH String 账号
XM String 姓名
SFLBDM String 身份类别代码，参照客户真实“标准”配置
LASTCHANGEPASSWORDTIME String 上次修改密码时间
更多返回信息 更多返回信息含义，请查看标准

二、用户查询(授权过滤)

根据账号获取身份平台用户信息,会根据授权对部门和岗位信息进行过滤

说明：需要进行用户数据授权

请求⽅式： GET（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/auth/userInfo/{userId}

注：https方式类似。

请求参数：

userId:  账号

参数说明：

参数 类型 是否必须 说明
userId String 是 账号。

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
        "SFZJYXQ": 1630566048964,
        "MZM": "汉族",
        "ZHZT": "正常",
        "IDCARD": "98754324565755435",
        "SFYXQJZ": 1632985264990,
        "JXRYZT": "在职",
        "ZZMM": "xx",
        "GATQWM": "xx",
        "CYM": "cengyongming",
        "XMPY": "yongliyi",
        "RZHINY": 1612162861804,
        "USERID": "30008",
        "orgInfo": [
            {
                "org": [
                    {
                        "title": 组织",
                        "key": "RJDZZZ",
                        "isLeaf": true,
                    }
                ],
                "gangwei": [
                    {
                        "title": "a",
                        "key": "R608636ffd8f7ed0006f145ae",
                        "isLeaf": true,
                    }
                ]
            }
        ],
        "objectId": "613069b83012b40006edb0ee",
        "GH": "30008",
        "GJ": "中国",
        "SFYXQQS": 1630566070491,
        "RYZT": "正常",
        "XB": "男性",
        "HYZKM": "未婚",
        "JKZKM": "健康或良好",
        "CSRQ": 1630479623278,
        "SFZJLXM": "护照",
        "SFLBDM": "员工",
        "LXDH": "0102325465",
        "XM": "用例1",
        "TEL": "18547212068",
        "personId": "612f2fdbbaa4d50006a1e98c",
        "XYZJM": "",
        "SFLBMC": "员工",
        "LASTCHANGEPASSWORDTIME": "2021-06-30T16:00:00.000+0000"
    }
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
GH String 账号
XM String 姓名
SFLBDM String 身份类别代码，参照客户真实“标准”配置
LASTCHANGEPASSWORDTIME String 上次修改密码时间
更多返回信息 更多返回信息含义，请查看标准

三、用户同步

根据用户的属性集合，分页查询用户信息。

说明：需要进行用户数据授权

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/pageQueryUsers

注：https方式类似。

请求参数：

{
 "currentPage": 1,
 "pageSize": 10,
 "reqParam":{"SFLBDM":"01"}
}

参数说明：

参数 类型 是否必须 说明
currentPage int 是 当前页
pageSize int 是 每页返回记录数
reqParam String 否 用户的属性集合

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
               "userList": [{
                "GH": "test",
                "ZHZT": "true",
                "COVERDEPARTMENTKEY": "123",
                "IDCARD": "123456789874653210",
                "PRZWMC": "无",
                "YDDH": "12345678901",
                "XB": "女性",
                "ZZMM": "群众",
                "JZGZT": "在职",
                "ISINITIALPASSWORD": true,
                "SFLBDM": "01",
                "SFZZ": "是",
                "XM": "test",
                "XMPY": "test",
                "USERID": "test",
                "orgInfo": [
                    {
                        "org": [
                            {
                                "title": "行政组织",
                                "code": null,
                                "key": "RJXZZZ",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": null,
                                "official": null,
                                "departmentId": null,
                                "organizationMethod": null
                            },
                            {
                                "title": "测试组织",
                                "code": null,
                                "key": "123",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": null,
                                "official": null,
                                "departmentId": null,
                                "organizationMethod": null
                            },
                            {
                                "title": "测试组织01",
                                "code": null,
                                "key": "1234",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": null,
                                "official": null,
                                "departmentId": null,
                                "organizationMethod": null
                            }
                        ],
                        "gangwei": [],
                        "gongzuo": [],
                        "organizationMethod": null
                    }
                ],
                "LABEL": [],
                "JG": "上海市",
                "LASTCHANGEPASSWORDTIME": "2022-01-05T16:00:00.000+0000",
                "objectId": "61d6c323dc867900065a9099"
            }
        ],
        "currentPage": 1,
        "pageSize": 10,
        "aggregatePageSortDtos": null,
        "totalPages": 9,
        "totalAmount": 89
    }
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
currentPage int 当前页
pageSize int 每页数量
totalPages int 总页数
totalAmount int 总记录数
userList List 用户信息列表， 用户信息返回参考 用户查询
更多返回信息 更多返回信息含义，请查看标准

四、用户同步(授权过滤)

根据用户的属性集合，分页查询用户信息。会根据授权对部门和岗位信息进行过滤

说明：需要进行用户数据授权

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/auth/pageQueryUsers

注：https方式类似。

请求参数：

{
 "currentPage": 1,
 "pageSize": 10,
 "reqParam":{"SFLBDM":"01"}
}

参数说明：

参数 类型 是否必须 说明
currentPage int 是 当前页
pageSize int 是 每页返回记录数
reqParam String 否 用户的属性集合

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
               "userList": [{
                "GH": "test",
                "ZHZT": "true",
                "COVERDEPARTMENTKEY": "123",
                "IDCARD": "123456789874653210",
                "PRZWMC": "无",
                "YDDH": "12345678901",
                "XB": "女性",
                "ZZMM": "群众",
                "JZGZT": "在职",
                "ISINITIALPASSWORD": true,
                "SFLBDM": "01",
                "SFZZ": "是",
                "XM": "test",
                "XMPY": "test",
                "USERID": "test",
                "orgInfo": [
                    {
                        "org": [
                            {
                                "title": "行政组织",
                                "code": null,
                                "key": "RJXZZZ",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": null,
                                "official": null,
                                "departmentId": null,
                                "organizationMethod": null
                            },
                            {
                                "title": "测试组织",
                                "code": null,
                                "key": "123",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": null,
                                "official": null,
                                "departmentId": null,
                                "organizationMethod": null
                            },
                            {
                                "title": "测试组织01",
                                "code": null,
                                "key": "1234",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": null,
                                "official": null,
                                "departmentId": null,
                                "organizationMethod": null
                            }
                        ],
                        "gangwei": [],
                        "gongzuo": [],
                        "organizationMethod": null
                    }
                ],
                "LABEL": [],
                "JG": "上海市",
                "LASTCHANGEPASSWORDTIME": "2022-01-05T16:00:00.000+0000",
                "objectId": "61d6c323dc867900065a9099"
            }
        ],
        "currentPage": 1,
        "pageSize": 10,
        "aggregatePageSortDtos": null,
        "totalPages": 9,
        "totalAmount": 89
    }
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
currentPage int 当前页
pageSize int 每页数量
totalPages int 总页数
totalAmount int 总记录数
userList List 用户信息列表， 用户信息返回参考 用户查询
更多返回信息 更多返回信息含义，请查看标准

五、用户增加（1.9版本）

当业务系统需要增加用户时，可以调用身份平台的增加用户接口。

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/save 该接口不返回用户信息

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/save/v2 该接口返回用户信息，并且记录日志。

注：https方式类似。

请求参数：

用户示例：

{
  "XM": "用例1",
  "XMPY": "yongliyi",
  "CYM": "cengyongming",
  "SFZJLXM": "A",
  "IDCARD": "98754324565755435",
  "XB": "1",
  "GJ": "中国",
  "MZM": "01",
  "CSRQ": 1630479623278,
  "TEL": "18547212068",
  "LXDH": "0102325465",
  "ZZMM": "01",
  "XYZJM": "10",
  "CSDM": "",
  "GATQWM": "01",
  "HYZKM": "10",
  "JKZKM": "1",
  "RYZT": "01",
  "SFZJYXQ": 1630566048964,
  "SFYXQQS": 1630566070491,
  "SFYXQJZ": 1632985264990,
  "GH": "00008",
  "JXRYZT": "02",
  "RZHINY": 1612162861804,
  "SFLBDM": "01",
  "organizationRootCodes": [
    "ZZFY"
  ],
  "orgInfo": [
    {
      "SZDW": "RJDZZZ",
      "GWMC": "01"
    }
  ]
}

参数说明：

参数 类型 是否必须 说明
XM string 是 姓名
XMPY string 否 姓名拼音
CYM string 否 曾用名
SFZJLXM string 否 身份证件类型 参考文档最后字典码值映射 【身份证件类型字典码值】
IDCARD string 否 身份证件号
XB string 否 性别 参考文档最后字典码值映射 【性别字典码值】
GJ string 否 国籍
MZM string 否 民族 具体码值请参考国家标准
CSRQ Long 否 出生日期
TEL string 否 绑定手机
LXDH string 否 联系电话
ZZMM string 否 政治面貌 具体码值请参考国家标准
XYZJM string 否 信仰宗教 具体码值请参考国家标准
CSDM string 否 出生地
GATQWM string 否 港澳台侨外 具体码值请参考国家标准
HYZKM string 否 婚姻状况 具体码值请参考国家标准
JKZKM string 否 健康状况 具体码值请参考国家标准
RYZT string 是 人员状态 参考文档最后字典码值映射 【人员状态字典码值】
SFZJYXQ Long 否 身份证件有效期
SFYXQQS Long 否 身份有效期(起始)
SFYXQJZ Long 否 身份有效期(截至)
GH string 否 账号；如果传值则以传值为准，如果不传值则以 身份前缀+自增编码规则自动生成。
JXRYZT string 是 人员状态 请联系管理员获取
RZHINY Long 否 入职年月
SFLBDM string 是 身份类别代码 参照客户真实“标准”配置，请联系管理员获取
organizationRootCodes List 否 根组织编码集合，用户新增到哪些组织。当应用组织人员管理API调用配置未配置或配置为通过参数传入对应组织编码时，会读取该参数
orgInfo.SZDW string 否 所在单位
orgInfo.GWMC string 否 岗位名称

注：

①用户增加接口请求参数中除了必填参数外，其他参数根据实际情况填写。

②由于保存或者更新用户受到数据权限控制，可能存在部分用户字段更新，部分未更新。

③由于数据源存在优先级设定，可能保存或者更新用户返回成功，但实际没有保存。如果需要保存，需联系管理员进行设定优先级。

返回结果：

接口1返回结果：

{
    "code": 200,
    "message": "OK",
    "data": true
}

接口2返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
        "SFZJYXQ": 1630566048964,
        "MZM": "01",
        "ZHZT": "true",
        "IDCARD": "98754324565755435",
        "SFYXQJZ": 1632985264990,
        "ZZMM": "01",
        "JXRYZT": "02",
        "GATQWM": "01",
        "CYM": "cengyongming",
        "XMPY": "yongliyi",
        "RZHINY": 1612162861804,
        "USERID": "50008",
        "orgInfo": [
            {
                "org": [
                    {
                        "title": "组织",
                        "key": "RJDZZZ",
                        "isLeaf": true
                    }
                ],
                "gangwei": [
                    {
                        "title": "a",
                        "key": "R608636ffd8f7ed0006f145ae",
                        "isLeaf": true
                    }
                ]
            }
        ],
        "objectId": "61306d8a3012b40006edb119",
        "GH": "50008",
        "GJ": "中国",
        "SFYXQQS": 1630566070491,
        "RYZT": "01",
        "XB": "1",
        "HYZKM": "10",
        "JKZKM": "1",
        "CSRQ": 1630479623278,
        "SFZJLXM": "A",
        "SFLBDM": "01",
        "LXDH": "0102325465",
        "PASSWORD": "/GIRtfarhKHVjZZDvu92Bw==",
        "XM": "用例1",
        "TEL": "18547212068",
        "personId": "612f2fdbbaa4d50006a1e98c",
        "XYZJM": "10",
        "SFLBMC": "管理人员"
    }
}

参数说明：

参数名 类型 说明
code String 状态码
message String 响应消息
data Boolean 处理结果

六、用户删除

当业务系统需要删除某个用户时，可以通过调用身份平台的删除用户接口。

请求⽅式： DELETE（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/user/{userId}

注：https方式类似。

请求参数：

示例：
http://self.xxx.com/linkid/api/aggregate/user/public/user/2018112188

参数说明：

参数 类型 是否必须 说明
userId string 是 账号。

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": true
}

参数说明：

参数 类型 说明
code String 状态码
message String 响应消息
data Boolean 处理结果

七、用户修改（1.9版本）

当业务系统需要修改用户信息，或者给用户授予某种业务含义时，可以直接调用身份平台用户修改接口，达成业务目标。

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/update 该接口不返回用户信息

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/update/v2 该接口返回用户信息，并且记录日志。

注：https方式类似。

请求参数：

用户示例：
{
    "XM": "用例1",
    "XMPY": "yongliyi",
    "CYM": "cengyongming",
    "SFZJLXM": "A",
    "IDCARD": "98754324565755435",
    "XB": "1",
    "GJ": "中国",
    "MZM": "01",
    "CSRQ": 1630479623278,
    "TEL": "18547212068",
    "LXDH": "0102325465",
    "ZZMM": "01",
    "XYZJM": "10",
    "CSDM": "",
    "GATQWM": "01",
    "HYZKM": "10",
    "JKZKM": "1",
    "RYZT": "01",
    "SFZJYXQ": 1630566048964,
    "SFYXQQS": 1630566070491,
    "SFYXQJZ": 1632985264990,
    "GH": "00008",
    "JXRYZT": "02",
    "RZHINY": 1612162861804,
    "SFLBDM": "01",
    "orgInfo": [
        {
            "SZDW": "RJDZZZ",
            "GWMC": "01"
        }
    ]
}

参数说明：

参数 类型 是否必须 说明
XM string 是 姓名
XMPY string 否 姓名拼音
CYM string 否 曾用名
SFZJLXM string 否 身份证件类型 参考文档最后字典码值映射 【身份证件类型字典码值】
IDCARD string 否 身份证件号
XB string 否 性别 参考文档最后字典码值映射 【性别字典码值】
GJ string 否 国籍
MZM string 否 民族 具体码值请参考国家标准
CSRQ Long 否 出生日期
TEL string 否 绑定手机
LXDH string 否 联系电话
ZZMM string 否 政治面貌 具体码值请参考国家标准
XYZJM string 否 信仰宗教 具体码值请参考国家标准
CSDM string 否 出生地
GATQWM string 否 港澳台侨外 具体码值请参考国家标准
HYZKM string 否 婚姻状况 具体码值请参考国家标准
JKZKM string 否 健康状况 具体码值请参考国家标准
RYZT string 否 人员状态 参考文档最后字典码值映射 【人员状态字典码值】
SFZJYXQ Long 否 身份证件有效期
SFYXQQS Long 否 身份有效期(起始)
SFYXQJZ Long 否 身份有效期(截至)
GH string 是 账号
JXRYZT string 否 人员状态 请联系管理员获取
RZHINY Long 否 入职年月
SFLBDM string 否 身份类别代码 参照客户真实“标准”配置，请联系管理员获取
orgInfo.SZDW string 否 所在单位
orgInfo.GWMC string 否 岗位名称

注：

  1. 用户增加接口请求参数中除了必填参数外，其他参数根据实际情况填写。
  2. 由于保存或者更新用户受到数据权限控制，可能存在部分用户字段更新，部分未更新。
  3. 由于数据源存在优先级设定，可能保存或者更新用户返回成功，但实际没有保存。如果需要保存，需联系管理员进行设定优先级。
  4. SFLBDM不支持自定义转换映射
  5. 更新用户v2接口，建议传SFLXDM字段，有的话支持字段解析(自定义字段-标准字段)的转换，没有的话字段需要和标准一致。前提：应用对接认证API配置了字段映射关系。

接口1返回结果：

{
    "code": 200,
    "message": "OK",
    "data": true
}

接口2返回结果：

{
  "code" : 200,
  "message" : "OK",
  "data" : {
    "AddUserInfo" : {
      "SFZJYXQ" : 1632987954007,
      "MZM" : "01",
      "ZHZT" : "true",
      "IDCARD" : "98754324******435",
      "SFYXQJZ" : 1632383162743,
      "JXRYZT" : "02",
      "ZZMM" : "01",
      "CYM" : "cengyongming",
      "XMPY" : "yongliyi",
      "RZHINY" : 1609487169031,
      "USERID" : "qa******",
      "orgInfo" : [ {
        "org" : [ {
          "title" : "组织",
          "key" : "RJDZZZ",
          "isLeaf" : true
        } ],
        "gangwei" : [ {
          "title" : "a",
          "key" : "R608636ffd8f7ed0006f145ae",
          "isLeaf" : true
        } ]
      } ],
      "LABEL" : [ ],
      "objectId" : "612f2fdbbaa4d50006a1e98e",
      "GH" : "qazwsx12",
      "GJ" : "中国",
      "SFYXQQS" : 1630568759688,
      "RYZT" : "01",
      "XB" : "0",
      "HYZKM" : "10",
      "pageId" : "5d03034dd9900b3b92ab2095",
      "JKZKM" : "1",
      "CSRQ" : 1536219914392,
      "SFZJLXM" : "A",
      "SFLBDM" : "01",
      "LXDH" : "0102325465",
      "XM" : "用例1",
      "TEL" : "18547212068",
      "personId" : "612f2fdbbaa4d50006a1e98c",
      "XYZJM" : "00",
      "SFLBMC" : "管理人员"
    },
    "state" : "success"
  }
}

参数说明：

参数名 类型 说明
code String 状态码
message String 响应消息
data Boolean 处理结果

八、更新用户组织岗位关系（1.9版本）

当业务系统需要更新某个用户时，可以通过调用身份平台的更新用户组织接口。

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/updateOrgAndPost

注：https方式类似。

请求参数：

{
    "type":"ADD",
    "userId":"3131234",
    "organizationRootCodes": [
      "ZZFY" 
    ],
    "orgInfo":[{
        "SZDW":"RJXZZZ",
        "GWMC":"RJXZZZ"
    }]
}

参数说明：

参数 类型 是否必须 说明
type string 操作类型 ADD为新增用户与部门关系，DEL为删除用户与部门关系
userId string 是 账号。
organizationRootCodes List 否 根组织编码集合，用户新增到哪些组织。当应用组织人员管理API调用配置未配置或配置为通过参数传入对应组织编码时，会读取该参数
SZDW string 是 所在单位code
GWMC string 是 所在岗位code

注意：

  1. type为"ADD", GWMC不能单独添加，必须与SZDW同时添加。
  2. type为"DEL",如果用户、部门、岗位在SID里是三元关系，则orgInfo中必须SZDW和GWMC都必须填写。
  3. type为"DEL",如果用户、部门在SID里是两元关系，则orgInfo中只需填写SZDW。

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": true
}

参数说明：

参数 类型 说明
code String 状态码
message String 响应消息
data Boolean 处理结果

九、根据组织code（页面中身份栏->组织管理->组织编码）获取部门下所有用户

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/users/public/pageQueryUsers/szdwcode/{pageId}

注：https方式类似。

请求参数：

{
    "currentPage": 1,
    "pageSize": 10,
    "reqParam": {
        "supplePersonCategory": "organization",
        "getSupplePersonItemId": "12312312223"
    }
}

参数说明：

参数 类型 是否必须 说明
supplePersonCategory string 是 根据组织code查询，固定传organization
getSupplePersonItemId string 是 组织code
pageId string 是 联系实施人员提供

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
        "reqParam": null,
        "userList": [
            {
                "GH": "yuki002",
                "ZHZT": "true",
                "IDCARD": "0831",
                "RYZT": "02",
                "XB": "9",
                "JXRYZT": "04",
                "pageId": "5d03034dd9900b3b92ab2095",
                "SFZJLXM": "A",
                "SFLBDM": "01",
                "XM": "Yuki",
                "XMPY": "Yuki",
                "USERID": "yuki002",
                "orgInfo": [
                    {
                        "org": [
                            {
                                "title": "组织",
                                "code": null,
                                "key": "RJDZZZ",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": "00",
                                "official": null,
                                "departmentId": null,
                                "order": null,
                                "isBuilding": null,
                                "definitionMode": null,
                                "organizationMethod": null,
                                "index": null
                            },
                            {
                                "title": "物业管理",
                                "code": null,
                                "key": "R60de699ec7ba600006528d53",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": "00",
                                "official": null,
                                "departmentId": null,
                                "order": null,
                                "isBuilding": null,
                                "definitionMode": null,
                                "organizationMethod": null,
                                "index": null
                            }
                        ],
                        "gangwei": null,
                        "gongzuo": null
                    }
                ],
                "personId": "610a7f6916baf60006dd96c0",
                "objectId": "610a7f6916baf60006dd96c2"
            },
            {
                "GH": "T10089",
                "ZHZT": "true",
                "CDID": "324234234",
                "IDCARD": "320826199708300620",
                "RYZT": "03",
                "XB": "1",
                "EMAIL": "sdfsdf",
                "LASTLOGINTIME": 1629888003618,
                "pageId": "60750bdfb48769085d08a38b",
                "SFZJLXM": "15",
                "SFLBDM": "11",
                "XM": "???",
                "XMPY": "zhanghengyuan",
                "USERID": "T10089",
                "orgInfo": [
                    {
                        "org": [
                            {
                                "title": "组织",
                                "code": null,
                                "key": "RJDZZZ",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": "00",
                                "official": null,
                                "departmentId": null,
                                "order": null,
                                "isBuilding": null,
                                "definitionMode": null,
                                "organizationMethod": null,
                                "index": null
                            },
                            {
                                "title": "物业管理",
                                "code": null,
                                "key": "R60de699ec7ba600006528d53",
                                "isLeaf": true,
                                "category": null,
                                "children": null,
                                "status": "00",
                                "official": null,
                                "departmentId": null,
                                "order": null,
                                "isBuilding": null,
                                "definitionMode": null,
                                "organizationMethod": null,
                                "index": null
                            }
                        ],
                        "gangwei": null,
                        "gongzuo": null
                    }
                ],
                "personId": "61078bd716baf60006dc8706",
                "GLRYZT": "02",
                "objectId": "6107ba4116baf60006dc9761",
                "SFLBMC": "????"
            }
        ],
        "currentPage": 0,
        "pageSize": 10,
        "aggregatePageSortDtos": null,
        "totalPages": 1,
        "totalAmount": 2,
        "userId": null,
        "paramOrRelation": null
    }
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值为部门code列表

十、微哨在用接口-应用同步用户信息

微哨通过配置认证api返回的属性， 获取对应的用户信息。

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/service/user/applicationconfig/userinfo

注：https方式类似。

请求参数：

{
    "usertype":"02",
    "currentPage":0,
    "pageSize":10
}

参数说明：

参数 类型 是否必须 说明
currentPage int 是 当前页
pageSize int 是 每页返回记录数
usertype string 是 人员类型，实际以客户现场配置位置

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
        "totalAmount": 1,
        "userPropertyNameValueDtos": [
            [
                {
                    "propertyValue": "女性",
                    "propertyName": "XB"
                },
                {
                    "propertyValue": "中国",
                    "propertyName": "GJ"
                },
                {
                    "propertyValue": "888888888888888888",
                    "propertyName": "IDCARD"
                },
                {
                    "propertyValue": "",
                    "propertyName": "SFZJYXQ"
                },
                {
                    "propertyValue": "1986-12-01",
                    "propertyName": "CSRQ"
                },
                {
                    "propertyValue": "叶雪雪",
                    "propertyName": "XM"
                },
                {
                    "propertyValue": "",
                    "propertyName": "XMPY"
                },
                {
                    "propertyValue": "",
                    "propertyName": "CYM"
                },
                {
                    "propertyValue": "1567111106",
                    "propertyName": "GH"
                },
                {
                    "propertyValue": "02",
                    "propertyName": "SFLBDM"
                },
                {
                    "propertyValue": "汉族",
                    "propertyName": "MZ"
                },
                {
                    "propertyName": "EMAIL"
                }
            ]
        ]
    }
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
totalAmount int 总记录数
userPropertyNameValueDtos List 用户信息列表
propertyName string 用户属性名称
propertyValue object 用户属性的值
更多用户属性 更多用户属性， 请查看标准

十一、微哨在用接口-根据账号查询用户信息

微哨通过配置认证api返回的属性， 获取对应的用户信息。

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/user/public/userinfo/bypropertynames

注：https方式类似。

请求参数：

{
    "propertyNames":[
        "GH",
        "XH"
    ],
    "value":"1"
}

参数说明：

参数 类型 是否必须 说明
propertyNames list 是 用户属性的名称， 根据账号查询传GH，传值参考客户具体标准
value string 是 用户属性的值， 账号

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": [
        {
            "propertyValue": "居民身份证",
            "propertyName": "SFZJLXM"
        },
        {
            "propertyValue": true,
            "propertyName": "ISINITIALPASSWORD"
        },
        {
            "propertyValue": "男性",
            "propertyName": "XB"
        },
        {
            "propertyValue": "中国",
            "propertyName": "GJ"
        },
        {
            "propertyValue": "true",
            "propertyName": "ZHZT"
        },
        {
            "propertyValue": "511623199802265719",
            "propertyName": "IDCARD"
        },
        {
            "propertyValue": "",
            "propertyName": "SFZJYXQ"
        },
        {
            "propertyValue": "1",
            "propertyName": "GH"
        },
        {
            "propertyValue": "在职",
            "propertyName": "JZGZT"
        },
        {
            "propertyValue": "2020-09-15",
            "propertyName": "CSRQ"
        },
        {
            "propertyValue": "xs测试14",
            "propertyName": "XM"
        },
        {
            "propertyValue": "",
            "propertyName": "XMPY"
        },
        {
            "propertyValue": "",
            "propertyName": "CYM"
        },
        {
            "propertyValue": "群众",
            "propertyName": "ZZMM"
        },
        {
            "propertyValue": "",
            "propertyName": "DZXX"
        },
        {
            "propertyValue": "",
            "propertyName": "DH"
        },
        {
            "propertyName": "YDDH"
        },
        {
            "propertyValue": "",
            "propertyName": "CSD"
        },
        {
            "propertyValue": "01",
            "propertyName": "SFLBDM"
        },
        {
            "propertyValue": "2020-10-21T16:00:00.000+0000",
            "propertyName": "LASTCHANGEPASSWORDTIME"
        },
        {
            "propertyValue": "汉族",
            "propertyName": "MZ"
        },
        {
            "propertyName": "EMAIL"
        },
        {
            "propertyValue": [
                "RJXZZZ"
            ],
            "propertyName": "SZDW"
        },
        {
            "propertyValue": "5f91215e74b038000764975d",
            "propertyName": "objectId"
        }
    ]
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
propertyName string 用户属性名称
propertyValue object 用户属性的值
更多用户属性 更多用户属性， 请查看标准

十二、微哨在用接口-增量同步用户

微哨增量从SourceId同步用户。

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/user/dataSource/public/pageQuery/time

注：https方式类似。

请求参数：

{
    "current":1,
    "size":"1",
    "startTime":"2010-01-01 00:00:00",
    "endTime":""
}

参数说明：

参数 类型 是否必须 说明
current list 是 当前页
size string 是 每页返回数据量
startTime string 是 查询这个时间之后有更新的用户数据,
格式："yyyy-MM-dd hh:mm:ss"
endTime string 否 查询这个时间之前有更新的用户数据，
格式："yyyy-MM-dd hh:mm:ss"

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
        "total": 100,
        "users": [
            {
                "GH": "R00166",
                "updatedTime": 1604913327223,
                "SFLBDM": "01",
                "szdwAndGwmc": [
                    {
                        "szdw": "R5f91269d45fc080006eab46b",
                        "gwmc": null,
                        "type": null,
                        "szdwSource": "RG_SourceID"
                    }
                ],
                "isDeleted": false,
                "XM": "xs教职工测试14",
                "LABEL": [],
                "EMAIL": null,
                "SZDW": [
                    "R5f91269d45fc080006eab46b"
                ]
            }
        ]
    }
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
total int 总数
GH string 用户属性名称
SFLBDM string 人员类型代码
XM string 姓名
SZDW list 所在单位代码， 一个人有多部门
szdwAndGwmc list 用户三元组数据
更多用户属性 更多用户属性， 请查看标准

十三、查询单个用户绑定的openId和unionId信息

前提：需要开启权限：应用->应用管理->应用配置修改页->查询用户第三方ID服务->勾选获取的第三方应用类型

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/public/authenCredential/queryAuthenCredentialIds 注：https方式类似。

请求参数：

{
    "userId":"T002",
    "clientName":"Wechat",
    "formSource":"abc123abc"
}

参数说明：

参数 类型 是否必须 说明
userId string 是 支持人id进行查询包括：账号，统一组织终身ID，手机号，证件号，密保邮箱
clientName string 是 支持的第三方应用类型：（Wechat-微信，EnterPriseWechat-企业微信，DingTalk-钉钉，FlyBook-飞书，Welink-welink，MicroSentinel-微哨，CashOauth-cashOauth，ISNI-isni）
formSource string 否 第三方应用的ID

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": [
        {
            "openId": null,
            "unionId": "wxe029446eb7d98f7a",
            "formSource": null
        },
        {
            "openId": "12346789",
            "unionId": null,
            "formSource": "abcd"
        },
        {
            "openId": null,
            "unionId": "wxe029446eb7d98f7a",
            "formSource": null
        }
    ]
}

参数说明：

参数 类型 说明
code int 返回状态code
message string 返回状态消息
data 自定义对象 返回值的自定义对象
openId string 是用户和应用共同生成的唯一id
unionId string 是用户和应用所有者共同生成的唯一id
formSource string 第三方应用的ID

支持查询的第三方应用类型

第三方应用类型 名称
Wechat 微信
EnterPriseWechat 企业微信
DingTalk 钉钉
FlyBook 飞书
Welink welink
MicroSentinel 微哨
CashOauth cashOauth
ISNI isni

错误代码映射表：

序号 错误代码 错误信息 错误原因
1 1730010 应用系统ID不能为空 认证的token获取不对
2 2080001 参数为空 参数校验失败
3 1130021 应用没有被分配获取用户的权限 未分配获取权限或者没有权限获取
4 1650006 用户不存在，用户ID：{0}。 用户不存在

十四、全量/增量查询用户绑定的第三方认证信息

前提：需要开启权限：应用->应用管理->应用配置修改页->查询用户第三方ID服务->勾选获取的第三方应用类型 前提：给应用系统添加数据授权：授权->数据授权管理->选择对应的应用系统->添加授权规则

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/public/authenCredential/getFullAuthenCredentialIds

请求类型: application/json;charset=utf-8

认证参数: Authorization: Bearer {token}

请求参数：

注：https方式类似。

{
    "currentPage":1,
    "pageSize":100,
    "timeStamp":0
}

参数说明：

参数 类型 是否必须 说明
currentPage int 是 分页页码
pageSize int 是 分页每页大小
timeStamp long 是 应用上次同步时间。SID从该时间戳以后开始同步

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
        "pageSize": 100,
        "pageNum": 1,
        "totalAmount": 2,
        "orders": null,
        "results": [
            {
                "userId": "dawwd21121dd",
                "orgLifeId":"dawwd21121dd",
                "openId": "123456",
                "unionId": null,
                "clientName": "corpWechatOauth2",
                "formSource": "abc",
                "logicDeleted": false
            },
            {
                "userId": "dawwd21121dd",
                "orgLifeId":"123456",
                "openId": "345678",
                "unionId": null,
                "clientName": "corpWechat",
                "formSource": "bcd",
                "logicDeleted": false
            }
        ]
    }
}
参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
pageSize int 分页每页长度
pageNum int 分页页码
totalAmount int 总数
orders list 排序字段这里不做返回，默认返回null
results.userId String 账号
results.orgLifeId String 组织终身ID,开启了组织终身ID返回组织终身ID，否则返回账号
results.unionId String 用户和应用所有者共同生成的唯一id
results.openId String 用户和应用共同生成的唯一id
results.formSource String 第三方应用的ID
results.logicDeleted boolean 认证信息是否删除标识
results.clientName String 第三方应用类型

十五、根据账号/身份证号查找用户多身份信息

请求⽅式： GET（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/getAllIdentity/{ID}

注：https方式类似。

请求参数：

参数说明：

参数 类型 是否必须 说明
ID string 是 账号/身份证号

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": [{
        "GH": "0120211016",
        "ZHZT": "true",
        "IDCARD": "54678654321456",
        "RYZT": "01",
        "JXRYZT": "02",
        "SFZJLXM": "A",
        "SFLBDM": "01",
        "XM": "测试008",
        "USERID": "0120211016",
        "LABEL": [
            "60810fca6de5f83120b9d86a"
        ],
        "personId": "614c5be6d5fbe40006d5b051",
        "objectId": "614c5be6d5fbe40006d5b053",
        "SFLBMC": "管理人员"        
    }]
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 用户对象 返回数据与其他用户接口返回相同

十六、根据账号判断身份有效性

请求⽅式： GET（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/checkVaildByUserId/{userId}

注：https方式类似。

请求参数：

参数说明：

参数 类型 是否必须 说明
userId string 是 账号。

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": true
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
当前身份有效：true
当前身份无效：false

十七、获取用户身份信息二维码

请求⽅式： POST（HTTPS或HTTP）

请求地址： http://self.xxx.com/linkid/api/aggregate/user/public/generateUserQrInfo

注：https方式类似。

请求参数：

{
    "currentPage": 1,
    "pageSize": 10,
    "reqParam": {
        "USERID": "11202311095",
        "XM": "xxxx"
    }
}

参数说明：

参数 类型 是否必须 说明
currentPage int 是 分页页码
pageSize int 是 分页每页大小
reqParam map 否 筛选条件参数
USERID string 否 学工号
XM string 否 姓名
... ... 否 身份标准属性数据项名

返回结果：

{
    "code": 200,
    "message": "OK",
    "data": {
        "reqParam": null,
        "resList": [
            {
                "url": "https://xxxx/info?code=1120180752&key=zqfbe3BYf5",
                "image": xxxx
            },
            {
                "url": "https://xxxx/info?code=1120180752&key=zqfbe3BYf5",
                "image": xxxx
            }
        ],
        "currentPage": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalAmount": 2
    }
}

参数说明：

参数 类型 说明
code int 返回状态code
message String 返回状态消息
data 自定义对象 返回值的自定义对象
currentPage int 分页页码
pageSize int 分页每页大小
reqParam map 筛选条件参数
totalPages int 总页数
totalAmount int 总数量
resList list 返回数据
url string 访问地址
image string 二维码，base64格式

错误代码映射表

序号 错误代码 错误信息 错误原因
1 1950001 {IDCARD，TEL}数据冲突 人/身份自身的ID字段之间冲突
2 1950004 [ZZZSID]和用户[01]的[ZZZSID]不匹配 同人的ID字段数据不一致
3 1950006 [TEL]和用户[312312]的[GH]数据冲突 跨ID冲突
5 1900002 [TEL]绑定手机格式不符合要求 数据校验失败
6 1900004 [TEL]绑定手机数据重复 输入数据和数据库中其它用户的数据重复
7 1900007 [XM]姓名不能为空 ①必填数据没有输入;②或者没有在SID一数一源中选中的该第三方应用，需联系管理员进行设置
8 2170030 XM姓名不能为空 姓名状态没有传
9 2170031 RYZT人员状态不能为空 人员状态字段没有传
10 2170032 SFLBDM身份类别代码不能为空 身份类别代码没有传
11 2170033 ...人员状态不能为空 人员状态没有传
12 2170034 身份类别代码不存在 身份类别代码传的不对
13 1730010 应用系统ID不能为空 认证的token获取不对
14 2080001 参数为空 参数校验失败
15 1130021 用户被分配没有权限。 未分配获取权限或者没有权限获取
16 1650006 用户不存在，用户ID：{0}。 用户不存在
17 1030047 当前页必须大于0 当前页必须大于0
18 2080001 参数为空 参数校验失败
19 1030048 每页要显示记录数必须大于0 每页要显示记录数必须大于0
20 9400004 应用ID：123456 未配置 查询用户第三方ID服务 应用ID：123456 未配置 查询用户第三方ID服务
21 1730009 参数值不能为空 参数值不能为空
22 2170015 查询参数有误 查询参数有误
23 2170016 每页数量超出限制 每页数量超出限制

字典码值映射

1.身份证件类型字典码值：

序号 码值 名称
1 1 居民身份证
2 15 港澳居民来往内地通行证
3 16 港澳居民居住证
4 17 台湾居民居住证
5 8 台湾居民来往内地通行证
6 A 护照

2.性别字典码值

序号 码值 名称
1 0 未知的性别
2 1 男性
3 2 女性
4 9 未说明的性别

3.人员状态字典码值

序号 码值 名称
1 01 正常
2 02 下落不明
3 03 死亡
©2020 锐捷网络股份有限公司 all right reserved，powered by Gitbook该文章修订时间： 2025-02-18 14:26:09

results matching ""

    No results matching ""