1. 登录/登出

1.1. 登录/登出说明

1.1.1. 登录/登出的定义

hengshi系统的登录/登出

结构说明

1.2. 接口说明

1.2.1. 服务端 api 登出

服务端 api 登出。

请求URL

POST /api/v1/auth/server-logout?access_token=${ACCESS_TOKEN}&sudo=${SUDO}

请求参数

URL 参数
字段 类型 是否必须 描述
access_token STRING access_token
sudo STRING 参考sudo说明
request body 参数

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值

1.2.2. 获取RSA公钥

获取RSA公钥

请求URL

POST /api/v1/rsa

接口说明

该接口为登陆接口的前置接口,用于获取rsa公钥和uuid

请求参数

URL 参数

request body 参数

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值

接口示例1: 获取公钥

POST /api/v1/rsa

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "uuid": "2c123d51-c805-4f6a-a2aa-a287e4d06fdb",
    "publicKey": "MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJ+24bPTsY0wAU2RWUAW9krPsXf4iNcVMCRwua7VPjD5TLmCjvy8wRZrQ68oC+KAvG6+LawjJ1kBVjEZQez3rmUCAwEAAQ=="
  }
}

1.2.3. 登陆

登陆

请求URL

POST /api/v1/auth/login

请求参数

URL 参数

request body 参数
字段 类型 说明
tenantCode STRING 租户企业id,平台方登录不需填写
email STRING 登陆用户邮箱或登陆名
password STRING 经过RSA公钥加密的密码,加密方式参考公钥加密说明
uuid STRING 通过 /api/v1/rsa 接口获取到的uuid

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data JSON 当前登录的用户,用户结构说明

接口示例1: 登陆

POST /api/v1/auth/login

返回:

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 1,
    "name": "test",
    "email": "test@hengshi.com",
    "description": "",
    "avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAA",
    "enable": true,
    "createdAt": "2020-07-02 18:51:06",
    "lastPasswordAt": "2020-07-02 18:51:06",
    "lastLoginAt": "2020-07-03 16:53:30",
    "resetPassword": false,
    "userType": "internal",
    "loginName": "test",
    "options": {},
    "userAttributes": {
      "aaa": "{\"星际穿越\",\"饮食男女\"}",
      "sys.email": "test@hengshi.com",
      "sys.login_name": "test",
      "sys.id": 1,
      "shuzi": 1,
      "n": "test1",
      "dan": "2020-07-03 16:22:32",
      "日期": [
        "2011-11-08",
        "2004-03-13"
      ],
      "sys.loginName": "test",
      "布尔": [
        true,
        false
      ],
      "sys.name": "test"
    },
    "roles": [
      {
        "id": 1,
        "name": "system admin"
      },
      {
        "id": 2,
        "name": "data admin"
      },
      {
        "id": 3,
        "name": "data analyst"
      },
      {
        "id": 4,
        "name": "data viewer"
      }
    ],
    "loginStatus": 0
  }
}

1.2.4. 登出

登出

请求URL

POST /api/v1/auth/logout

接口说明

登出根据cookies获得的当前登陆用户

请求参数

URL 参数

request body 参数

返回对象的格式说明

results matching ""

    No results matching ""

    衡石系统函数列表 认证方式