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

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


根据第三方用户Id获取关系

<p><strong>简要描述:</strong> </p> <ul> <li>根据第三方用户Id获取关系,<code>公有云版本仅限基于企业微信、钉钉等集成场景</code></li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{Host}/v2/user/getUserRelation</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>GET </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;">corpUserId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>第三方用户Id</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code>{Host}/v2/user/getUserRelation?timestamp=1618837301125&amp;projectId=449abe0c-e014-4836-8b60-d868c217599c&amp;appKey=ak&amp;sign=x&amp;corpUserId=id</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