获取用户基本信息

接口地址:/api/v1/user/baseInfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
user_id	user_id	query	true	string

响应状态:

状态码	说明	schema
200	OK	UserBaseinfoResponse
404	未找到资源

响应参数:

参数名称	参数说明	类型	schema
account	用户账号	string
ban	是否被禁用	boolean
email	邮箱	string
groups	用户组信息	array
phone	预留字段，暂无手机号信息	string
photo	预留字段，暂无photo信息	string
role	角色	string
userExtraInfo	用户额外信息	Object详见响应示例	UserExtraInfo

响应示例:

{
    "account": "", 
    "ban": false, // 是否被禁用
    "email": "", // 邮箱
    "groups": ["groupId"], // 用户组id列表
    "phone": "", // 预留字段，暂无手机号信息
    "photo": "", //预留字段，暂无photo信息
    "role": "tn_2_DATA_ANALYST", //tn_2表示租户id，DATA_ANALYST：角色信息
    "userExtraInfo": { // 用户额外信息
        //用户偏好设置信息
        "userPreference": {
            "accelerationSwitch": "", //工作是否开启加速推进
            "downloadLimit": 0, // 下载/订阅最大行数
            "queryLimit": 0, // 工作簿查询行数
            // 工作簿版本保留时间
            "worksheetVersionRetentionPeriod": { 
                "unit": "DAY/MONTH/YEAR", //枚举值
                "value": 0
            }
        }
    },
    "username": ""
}

修改自己密码

接口地址:/api/v1/user/resetPassword

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "newPassword": "",
  "originPassword": ""
}

请求体body参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
newPassword	新密码		false	string
originPassword	旧密码		false	string

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

暂无

响应示例:

获取自己基本信息

接口地址:/api/v1/user/selfInfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码	说明	schema
200	OK	UserBaseinfoResponse
404	未找到资源

响应参数:

参数名称	参数说明	类型	schema
account	用户账号	string
ban		boolean
email		string
groups	用户组信息	array
phone		string
photo		string
role	角色	string
userExtraInfo		Object详见示例	UserExtraInfo
username	用户名	string

响应示例:

{
  "data":{
    "account": "", 
    "ban": false, // 是否被禁用
    "email": "", // 邮箱
    "groups": ["groupId"], // 用户组id列表
    "phone": "", // 预留字段，暂无手机号信息
    "photo": "", //预留字段，暂无photo信息
    "role": "tn_2_DATA_ANALYST", //tn_2表示租户id，DATA_ANALYST：角色信息
    "userExtraInfo": { // 用户额外信息
        //用户偏好设置信息
        "userPreference": {
            "accelerationSwitch": "", //工作是否开启加速推进
            "downloadLimit": 0, // 下载/订阅最大行数
            "queryLimit": 0, // 工作簿查询行数
            // 工作簿版本保留时间
            "worksheetVersionRetentionPeriod": { 
                "unit": "DAY/MONTH/YEAR", //枚举值
                "value": 0
            }
        }
    },
    "username": ""
  },
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

修改自己邮箱

接口地址:/api/v1/user/updateEmail

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "email": ""
}

请求体boyd参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	UpdateEmailRequest	UpdateEmailRequest
email	邮箱		false	string

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"",
  "errorMsg":"",
  "success" : true / false
}

租户用户

查询用户

接口地址:/api/v1/tenant/user

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
keyword	搜索关键字(用户名)	query	false	string
page_number	当前第几页，默认1	query	false	integer(int32)
page_size	每页大小，默认500	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	UsersResponse
404	未找到资源

响应参数:

参数名称	参数说明	类型
account	账号信息	string
gmtUpdate	更新时间	integer(64)
groups	用户所在的用户组信息	Object详见示例
role	角色信息	Object详见示例
type	USER	String
updateOperator	更新人	String
userId	用户id	String
username	同账号信息	String

响应示例:

{
  "data":[
    {
        "account": "",
        "groups": [{
          "name":"",
          "userGroupId":""
        }],
        "gmtUpdate":0,
        "updateOperator":"",
        "role":{
            "roleDesc": "负责特定租户的管理，有租户内的全部权限；租户管理员可以指定平台管理员",
            "roleId": "tn_6_ADMIN",
            "roleName": "租户管理员",
            "roleType": "SYS",
            "sysCode": "ADMIN"
        }
        "type": "USER",
        "userId": "",
        "username":""
    }
  ],
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

创建账号

接口地址:/api/v1/tenant/user/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "username": "",
  "groupList": [],
  "password": "",
  "role": "",
  "forceUpdatePassword": true / false
}

请求体body参数:

参数名称	参数说明	是否必须	数据类型	schema
username	账号	true	string
groupList		false	array	string
password	密码	true	string
role	角色,可用值:ADMIN,ANALYST,DATA_ANALYST,MANAGER,MEMBER,OWNER,USAGER	true	string
forceUpdatePassword	首次登录是否需要强制修改密码	true	boolean

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

删除用户

接口地址:/api/v1/tenant/user/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "userId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId			true	string

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}