一、用户管理

1.1 添加用户

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/users/create
  • 方法:post

1.1.1 入参

字段名 属性 是否必填 备注
username string 必填 用户名
password string 必填 密码
password2 string 必填 确认密码
mobile int 必填 手机号
email string 必填 邮箱地址
real_name string 必填 真实姓名
department string 必填 所在部门

1.1.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
username string 用户名,唯一标识
mobile string 手机号,唯一
email string 邮箱地址,唯一
real_name string 真实姓名
department string 所在部门

1.1.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

1.2 登录接口

  • 权限:( 任何人 )
  • 地址:http://120.79.159.67:8000/api/v1/users/login
  • 方法:POST
  • 示例用户:qxj/123456789

token失效了就返回401状态了
返回信息:{“detail”:”Signature has expired.”}

用户登录可以使用:用户名、手机号、邮箱地址

1.2.1 入参

字段名 属性 是否必填 备注
username string 必填 用户名/手机号/邮箱地址
password string 必填 密码

1.2.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
token string JWT登录凭证token,需要保存,访问需要带有这个token
administrator bool 是否为管理员
username string 用户名
real_name string 用户真实姓名

1.2.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

1.3 查询用户列表

  • 权限:( 仅Admin )
  • 默认:page=1,page_size=10
  • 地址:http://120.79.159.67:8000/api/v1/users/list
  • 方法:GET

1.3.1 入参

字段名 属性 是否必填 备注
page int 选填 页码
page_size int 选填 页大小
conditions string 选填 用户名、真实姓名、部门名称、邮箱地址、手机号

1.3.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
username string 用户名,唯一标识
real_name string 真实姓名
mobile string 手机号,唯一
email string 邮箱地址,唯一
department string 所在部门
total_record int 所有数据数量
total_page int 一共多少页

1.3.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

1.4 查询个人信息

  • 权限:( 仅登录 )
  • 地址:http://120.79.159.67:8000/api/v1/users/detail
  • 方法:GET

1.4.1 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
username string 用户名,唯一标识
real_name string 真实姓名
mobile string 手机号,唯一
email string 邮箱地址,唯一
department string 所在部门

1.4.2 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

1.5 修改个人信息

  • 权限:( 仅登录 )
  • 地址:http://120.79.159.67:8000/api/v1/users/detail
  • 方法:PUT

1.5.1 入参

字段名 属性 是否必填 备注
real_name string 必填 真实姓名
department string 必填 所在部门
mobile string 必填 要修改的手机号
email string 必填 要修改的邮箱地址

1.5.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
username string 用户名,唯一标识
real_name string 真实姓名
mobile string 修改后的手机号
email string 修改后的邮箱地址
department string 所在部门

1.5.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

1.6 修改登录密码

  • 权限:( 仅登录 )
  • 地址:http://120.79.159.67:8000/api/v1/users/update_password
  • 方法:PUT

1.6.1 入参

字段名 属性 是否必填 备注
password string 必填 老密码
password2 string 必填 新密码
password3 string 必填 确认新密码

1.6.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
username string 用户名,唯一标识

1.6.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

1.7 修改用户为Admin用户

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/users/super_manager
  • 方法:PUT

1.7.1 入参

字段名 属性 是否必填 备注
username string 必填 用户名,唯一标识
administrator bool 必填 true=Admin,false=普通用户

1.7.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
username string 用户名,唯一标识
administrator bool 是否为Admin用户

1.7.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

1.8 账号、手机号、邮箱是否存在

  • 权限:( 任何人 )
  • 地址:http://120.79.159.67:8000/api/v1/users/count?username=admin
  • 方法:GET
  • 地址:http://120.79.159.67:8000/api/v1/users/count?mobile=18805407688
  • 方法:GET
  • 地址:http://120.79.159.67:8000/api/v1/users/count?email=885097398@qq.com
  • 方法:GET

1.8.1 入参

字段名 属性 是否必填 备注
username/mobile/email string 任意选择其中一个 用户名/手机号/邮箱地址

1.8.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
username/mobile/email string 用户名/手机号/邮箱地址
count int 当前输入用户名/手机号/邮箱地址已经存在多少个

1.8.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

二、权限组管理

2.1 创建权限组

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/users/create_group
  • 方法:POST

2.1.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识
group_name string 必填 权限组名
review_user string 必填 审批人 username,就是上方用户登录的用户名( 多个用户就用“英文逗号”分隔 )

2.1.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
group_name string 权限组名
review_user string 审批人 username,就是上方用户登录的用户名

2.1.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

2.2 查询权限组列表

  • 权限:( 仅Admin )
  • 默认:page=1,page_size=10
  • 地址:http://120.79.159.67:8000/api/v1/users/list_group
  • 方法:GET

2.2.1 入参

字段名 属性 是否必填 备注
page int 选填 页码
page_size int 选填 页大小
conditions string 选填 权限组标识、权限组名

2.2.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
group_name string 权限组名
review_user string 审批人 username,就是上方用户登录的用户名
real_name_list string 审批人 真实姓名,用户名称来源于响应 review_user 数据

2.2.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

2.3 修改权限组名

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/users/update_group_name
  • 方法:PUT

2.3.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识
group_name string 必填 权限组名

2.3.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
group_name string 权限组名

2.3.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

2.4 修改权限组审批人

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/users/update_group_review
  • 方法:PUT

2.4.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识
review_user string 必填 审批人 username,就是上方用户登录的用户名( 多个用户就用“英文逗号”分隔 )

2.4.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
review_user string 审批人 username,就是上方用户登录的用户名

2.4.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

2.5 删除权限组

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/users/update_group_review
  • 方法:DELETE

2.5.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识

2.5.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

2.5.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

2.6 查询权限组(接口使用)

  • 权限:( 仅登录 )
  • 地址:http://120.79.159.67:8000/api/v1/users/total_list_group
  • 方法:GET

2.6.1 入参

2.6.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
group_name string 权限组名

2.6.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

2.7 修改权限组通知URL地址

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/users/group_message_url
  • 方法:POST

2.7.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识
dingding_url string 必填 钉钉 消息通知群 URL 地址
wechat_url string 必填 企业微信 消息通知群 URL 地址

2.7.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
dingding_url string 钉钉 消息通知群 URL 地址
wechat_url string 企业微信 消息通知群 URL 地址

2.7.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

2.8 查询权限组通知URL地址

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/users/group_message_url
  • 方法:GET

2.8.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识

2.8.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
dingding_url string 钉钉 消息通知群 URL 地址
wechat_url string 企业微信 消息通知群 URL 地址

2.8.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

三、用户授权管理

3.1 授权用户到权限组

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/permission/create_permissions
  • 方法:POST

备注:如果是 Admin 用户,结果集是所有授权信息

3.1.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识
username_tag string 必填 登录使用的 用户名,唯一标识
permission string 必填 r=只读工单权限,w=读写工单权限

3.1.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
username_tag string 登录使用的 用户名,唯一标识
permission string r=只读工单权限,w=读写工单权限

3.1.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

3.2 查询授权列表

  • 权限:( 仅登录 )
  • 默认:page=1,page_size=10
  • 地址:http://120.79.159.67:8000/api/v1/permission/create_permissions
  • 方法:GET

如果是 Admin 用户,结果集是所有所有授权信息。普通用户 仅返回自己拥有审批权限的授权信息数据

3.2.1 入参

字段名 属性 是否必填 备注
page int 选填 页码
page_size int 选填 页大小
conditions string 选填 用户名、组标识、真实姓名、权限组名

3.2.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
group_name string 权限组名
username_tag string 登录使用的 用户名,唯一标识
real_name string 用户真实姓名

3.2.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

3.3 删除授权用户到权限组

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/permission/delete_permissions
  • 方法:DELETE

3.3.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识
username_tag string 必填 登录使用的 用户名,唯一标识

3.3.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

3.3.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息

3.4 修改用户到权限组r/w权限标识

  • 权限:( 仅Admin )
  • 地址:http://120.79.159.67:8000/api/v1/permission/update_permissions
  • 方法:PUT

3.4.1 入参

字段名 属性 是否必填 备注
group_tag string 必填 权限组标识,唯一标识
username_tag string 必填 登录使用的 用户名,唯一标识
permission string 必填 r=只读工单权限,w=读写工单权限

3.4.2 正确出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
group_tag string 权限组标识,唯一标识
username_tag string 登录使用的 用户名,唯一标识
permission string r=只读工单权限,w=读写工单权限

3.4.3 错误出参

字段名 属性 备注
code int 状态码
message string 请求成功/失败消息
文档更新时间: 2022-04-19 20:06   作者:老A ✍