明道企业授权开放接口文档

明道企业授权开放接口文档


批量同步用户

<p><strong>简要描述:</strong> </p> <ul> <li>批量同步用户,一次最多可同步500个用户,<code>公有云版本不支持</code></li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{Host}/v2/user/upsertUsers</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST (application/json)</li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">users</td> <td style="text-align: left;">是</td> <td style="text-align: left;">User[]</td> <td>用户信息集合</td> </tr> </tbody> </table> <p>User 实体:</p> <p><strong>注意:如果原来明道云用户对应字段有值,但调用接口未赋值,则会清空此用户字段</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">corpUserId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>第三方用户Id</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>用户名</td> </tr> <tr> <td style="text-align: left;">email</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>邮箱,与 mobilePhone 不能同时为空</td> </tr> <tr> <td style="text-align: left;">mobilePhone</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>手机号,与 email 不能同时为空</td> </tr> <tr> <td style="text-align: left;">contactPhone</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>座机</td> </tr> <tr> <td style="text-align: left;">jobNumber</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>工号</td> </tr> <tr> <td style="text-align: left;">departmentIds</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string[]</td> <td>第三方部门Id集合</td> </tr> <tr> <td style="text-align: left;">positions</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string[]</td> <td>职位集合</td> </tr> <tr> <td style="text-align: left;">emptyCover</td> <td style="text-align: left;">否</td> <td style="text-align: left;">bool</td> <td>当非必填字段为空时,是否覆盖原来的值,默认:true(覆盖) 【v3.0.0+】</td> </tr> </tbody> </table> <p><strong>提交数据示例</strong></p> <pre><code>{ "users": [ { "corpUserId": "string", "name": "string", "departmentIds": [ "string" ], "positions": [ "string" ], "email": "string", "mobilePhone": "string", "contactPhone": "string", "jobNumber": "string", "emptyCover": true } ], "appKey": "string", "sign": "string", "timestamp": 0, "projectId": "string" }</code></pre> <p><strong>返回数据说明</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">int</td> <td>错误码</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">string</td> <td>错误描述,成功为空</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">UserRelation[]</td> <td>用户关系集合</td> </tr> </tbody> </table> <p>UserRelation 实体:</p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">corpUserId</td> <td style="text-align: left;">string</td> <td>第三方用户Id</td> </tr> <tr> <td style="text-align: left;">projectId</td> <td style="text-align: left;">string</td> <td>明道云组织编号</td> </tr> <tr> <td style="text-align: left;">accountId</td> <td style="text-align: left;">string</td> <td>明道云账号Id</td> </tr> </tbody> </table> <p><strong>成功</strong></p> <pre><code>{ "data": [ { "corpUserId": "string", "projectId": "string", "accountId": "string" } ], "code": 1, "message": "" }</code></pre> <p><strong>失败</strong></p> <pre><code>{ "code": 10001, "message": "错误描述" }</code></pre>

页面列表

ITEM_HTML