SAAS HIVE596认证授权方案

API文档


登录

<p>[TOC]</p> <h3>功能介绍:</h3> <ul> <li>通过用户名和密码登录系统获取令牌</li> </ul> <h3>接口约束:</h3> <ul> <li>无</li> </ul> <h3>URI:</h3> <p><code>Post {{baseUrl}}/auth/authentication/login</code></p> <h3>请求消息:</h3> <p><strong>请求头</strong> 请求头如表1所示。 表1 请求参数:</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;">sobeycloud-system</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>登录系统</td> </tr> <tr> <td style="text-align: left;">sobeycloud-site</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>用户站点</td> </tr> </tbody> </table> <p><strong>请求参数</strong> 请求参数如表2所示。</p> <p>表2 请求参数:</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;">LOGINNAME</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>登录名</td> </tr> <tr> <td style="text-align: left;">LOGINPWD</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>登录密码</td> </tr> <tr> <td style="text-align: left;">LOGINSUBSYSTEM</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>登录系统</td> </tr> <tr> <td style="text-align: left;">LOGINIP</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>客户端ip</td> </tr> </tbody> </table> <h3>请求示例:</h3> <pre><code>POST /auth/authorize/action?action-id=isusekey sobeycloud-site: S1 sobeycloud-token: SjUAxwMUwkpuY+CNt1daEMoVAVE= Content-Type: application/json { "LOGINNAME":"admin", "LOGINPWD":"SobeyHive2016", "LOGINSUBSYSTEM":"WEBCM", "LOGINIP":"172.16.135.100" }</code></pre> <hr /> <h3>响应消息:</h3> <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;">logininfoid</td> <td style="text-align: left;">string</td> <td>系统生成的登录id</td> </tr> <tr> <td style="text-align: left;">usertoken</td> <td style="text-align: left;">string</td> <td>用户令牌</td> </tr> </tbody> </table> <h3>响应示例:</h3> <p><strong>响应成功示例</strong> </p> <pre><code> { "code": "0", "msg": "successful", "ext": { "userid": 1, "usercode": "admin", "logininfoid": 15838, "loginsubsystem": "WEBCM", "logintime": "2021-09-16T11:38:17.0197486+08:00", "loginip": "172.16.135.100", "newrefreshtime": "2021-09-16T11:38:17.0198761+08:00", "usertoken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsic29iZXkiXSwidXNlcl9pbmZvIjp7InNpdGUiOiJTMSIsInVzZXJJZCI6IjEiLCJsb2dpbk5hbWUiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJ1c2VyQ29kZSI6ImFkbWluIiwidXNlclR5cGUiOjEsImVtYWlsIjpudWxsLCJuaWNrTmFtZSI6ImFkbWluIiwiZGVzY3JpcHRpb24iOm51bGwsImF2YXRhciI6bnVsbCwicGhvbmUiOm51bGwsInBhc3N3b3JkIjpudWxsLCJleHRlbmQiOm51bGwsInJvbGVzIjpbImFkbWluX1MxIl0sImNvbnRlbnRQcml2aWxlZ2VzIjpbInByaXZhdGVfYWRtaW46KiIsInB1YmxpY19TMToqIiwiQW5vbnltb3VzOioiXSwicGVybWlzc2lvbnMiOm51bGwsImdyb3VwcyI6WyJvd25lcl9hZG1pbjoqIl0sIm9yZ2FuaXphdGlvbnMiOlt7InNpdGVDb2RlIjoiUzEiLCJzaXRlTmFtZSI6bnVsbCwiaWQiOjEsIm9yZ2FuaXphdGlvbkNvZGUiOiJEYWFhIiwib3JnYW5pemF0aW9uTmFtZSI6IuWFqOmDqCIsImRlc2NyaXB0aW9uIjoi5qC56YOo6ZeoIiwicGFyZW50SWQiOi0xLCJwYXJlbnRPcmdhbml6YXRpb24iOm51bGwsIm9wZXJhdGUiOjAsInR5cGUiOm51bGwsImV4dGVuZEF0dHJpYnV0ZXMiOm51bGwsImV4dGVybmFsQ29kZSI6bnVsbCwiaGFzQ2hpbGRyZW4iOm51bGwsImNyZWF0ZVRpbWUiOm51bGwsInRlbmFudENvZGVzIjpudWxsfV0sInJlbGF0aW9uSWRzIjpudWxsLCJjbGllbnRDb2RlcyI6bnVsbCwibG9ja2VkIjpmYWxzZSwiZGlzYWJsZSI6ZmFsc2UsInVzZWRMb2dpblR5cGUiOm51bGwsImJvdW5kVHBhdXRoVHlwZXMiOltdLCJyb290VXNlciI6dHJ1ZSwicGFyZW50Q29kZSI6IjJkM2YyOGI3NGEzYTdlZGRkY2E0MTEzMTVjNDI3Mzg5IiwiaW5pdGlhbGl6ZWQiOnRydWUsInNpdGVUeXBlIjpudWxsLCJ0d29GYWN0b3JDaGVjayI6ZmFsc2UsImV4cGlyZVRpbWUiOm51bGwsInNpdGVTdGF0dXMiOm51bGwsInRlbmFudENvZGVzIjpudWxsLCJlbmNyeXB0U2VjcmV0S2V5IjpudWxsLCJwd2RDaGFuZ2VUaW1lIjoxNTU5NTM0NzIyMDAwLCJwd2RDaGFuZ2VQZXJpb2QiOi0xLCJhZG1pbiI6dHJ1ZX0sImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfbmFtZSI6ImFkbWluIiwic2NvcGUiOlsiYWxsIl0sImV4cCI6MTYzMTc3MDY5NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbl9TMSJdLCJqdGkiOiI2MDMzZGRkNS01NWY3LTQ2MGUtYWFmMy1hOGViYTZmNDE4MzciLCJjbGllbnRfaWQiOiJXRUJDTSJ9.UAohcs7oo2JOY3_KAC8RYxG5Nyq0gCQr9Un6NJWWmxw", "loginname": "admin", "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsic29iZXkiXSwidXNlcl9pbmZvIjp7InNpdGUiOiJTMSIsInVzZXJJZCI6IjEiLCJsb2dpbk5hbWUiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJ1c2VyQ29kZSI6ImFkbWluIiwidXNlclR5cGUiOjEsImVtYWlsIjpudWxsLCJuaWNrTmFtZSI6ImFkbWluIiwiZGVzY3JpcHRpb24iOm51bGwsImF2YXRhciI6bnVsbCwicGhvbmUiOm51bGwsInBhc3N3b3JkIjpudWxsLCJleHRlbmQiOm51bGwsInJvbGVzIjpbImFkbWluX1MxIl0sImNvbnRlbnRQcml2aWxlZ2VzIjpbInByaXZhdGVfYWRtaW46KiIsInB1YmxpY19TMToqIiwiQW5vbnltb3VzOioiXSwicGVybWlzc2lvbnMiOm51bGwsImdyb3VwcyI6WyJvd25lcl9hZG1pbjoqIl0sIm9yZ2FuaXphdGlvbnMiOlt7InNpdGVDb2RlIjoiUzEiLCJzaXRlTmFtZSI6bnVsbCwiaWQiOjEsIm9yZ2FuaXphdGlvbkNvZGUiOiJEYWFhIiwib3JnYW5pemF0aW9uTmFtZSI6IuWFqOmDqCIsImRlc2NyaXB0aW9uIjoi5qC56YOo6ZeoIiwicGFyZW50SWQiOi0xLCJwYXJlbnRPcmdhbml6YXRpb24iOm51bGwsIm9wZXJhdGUiOjAsInR5cGUiOm51bGwsImV4dGVuZEF0dHJpYnV0ZXMiOm51bGwsImV4dGVybmFsQ29kZSI6bnVsbCwiaGFzQ2hpbGRyZW4iOm51bGwsImNyZWF0ZVRpbWUiOm51bGwsInRlbmFudENvZGVzIjpudWxsfV0sInJlbGF0aW9uSWRzIjpudWxsLCJjbGllbnRDb2RlcyI6bnVsbCwibG9ja2VkIjpmYWxzZSwiZGlzYWJsZSI6ZmFsc2UsInVzZWRMb2dpblR5cGUiOm51bGwsImJvdW5kVHBhdXRoVHlwZXMiOltdLCJyb290VXNlciI6dHJ1ZSwicGFyZW50Q29kZSI6IjJkM2YyOGI3NGEzYTdlZGRkY2E0MTEzMTVjNDI3Mzg5IiwiaW5pdGlhbGl6ZWQiOnRydWUsInNpdGVUeXBlIjpudWxsLCJ0d29GYWN0b3JDaGVjayI6ZmFsc2UsImV4cGlyZVRpbWUiOm51bGwsInNpdGVTdGF0dXMiOm51bGwsInRlbmFudENvZGVzIjpudWxsLCJlbmNyeXB0U2VjcmV0S2V5IjpudWxsLCJwd2RDaGFuZ2VUaW1lIjoxNTU5NTM0NzIyMDAwLCJwd2RDaGFuZ2VQZXJpb2QiOi0xLCJhZG1pbiI6dHJ1ZX0sImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfbmFtZSI6ImFkbWluIiwic2NvcGUiOlsiYWxsIl0sImF0aSI6IjYwMzNkZGQ1LTU1ZjctNDYwZS1hYWYzLWE4ZWJhNmY0MTgzNyIsImV4cCI6MTYzNDM1NTQ5NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbl9TMSJdLCJqdGkiOiI4ZjEzYTBkNy02YmY2LTQ0NzUtYThjYS1hOWM2MTRlNzE2YTMiLCJjbGllbnRfaWQiOiJXRUJDTSJ9.7Ypj9QkvMITA20caQHCwFe82pNX7gx5-M1_3iJtBNxc", "refreshTokenExpireTime": 7199, "userTokenExpireTime": 7199, "site": "S1" } }</code></pre> <p><strong>响应失败示例</strong> </p> <pre><code> { "code": "Auth.0014", "msg": "系统内部错误" }</code></pre> <hr /> <h3>错误码</h3> <p>参考 <a href="https://www.showdoc.com.cn/mbhauth/7655637558569867" title="错误码说明">错误码说明</a></p> <h3>状态码</h3> <p>参考 <a href="https://www.showdoc.com.cn/mbhauth/7655637558569867" title="状态码说明">状态码说明</a></p>

页面列表

ITEM_HTML