package
0.0.0-20240816161103-86d552bf9f5a
Repository: https://github.com/jimu-server/org.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

AllMenu godoc @Summary 获取菜单 @Description 获取前端路由菜单树 @Tags web @Accept json @Produce json @Success 200 {object} resp.Response{data=[]model.Router} @Failure 500 {object} resp.Response @Router /menu [get].
No description provided by the author
CheckEmailVerify @Summary 验证用户密码 @Description 验证用户密码 @Tags 用户接口 @Accept json @Produces json @Param verify path string true "验证信息" @Router /public/secure/email/:verify [post].
CheckPassword @Summary 验证用户密码 @Description 验证用户密码 @Tags 用户接口 @Accept json @Produces json @Param args body PasswordVerify true "请求体" @Router /api/user/secure/check/password [post].
CheckPhoneCode @Summary 验证码校验 @Description 更新用户手机号,验证码校验 @Tags 用户接口 @Accept json @Produces json @Param args body SecureArgs true "请求体" @Router /api/user/secure/update/phone/code/check [post].
No description provided by the author
CreateOrg @Summary 创建组织 @Description 创建组织 @Tags 管理系统 @Accept json @Produces json @Param args body model.Org true "请求体" @Router /api/org/create [post].
No description provided by the author
No description provided by the author
No description provided by the author
DeleteOrg @Summary 删除组织 @Description 删除组织 @Tags 管理系统 @Accept json @Produces json @Param args body model.Org true "请求体" @Router /api/org/delete [post].
No description provided by the author
No description provided by the author
Dictionary @Summary 获取字典信息 @Description 获取字典信息 @Tags 管理系统 @Accept json @Produces json @Router /api/dictionary [get].
ForgetCode @Summary 忘记密码验证 @Description (手机号/邮箱号)重置密码获取验证码 @Tags 登录 @Accept json @Produces json @Param args body ForGetArgs true "请求体" @Router /public/forget/code [get].
ForgetCodeCheck @Summary 验证码验证 @Description (手机号/邮箱号)重置密码获取验证码验证 @Tags 登录 @Accept json @Produces json @Param args body ForGetArgs true "请求体" @Router /public/forget/code/check [post].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetOrg @Summary 获取组织列表 @Description 获取组织列表 @Tags 管理系统 @Accept json @Produces json @Router /api/org/list [get].
GetOrgAllUserList @Summary 获取所有的用户列表 @Description 获取所有的用户列表 @Tags 管理系统 @Produces json @Param args query OrgUserListArgs true "查询参数" @Router /api/org/user/all [get].
No description provided by the author
GetOrgRoleList @Summary 获取组织下所有的角色列表 @Description 获取组织下所有的角色列表 @Tags 管理系统 @Accept json @Produces json @Param args query OrgRoleListArgs true "查询参数" @Router /api/org/role/list [get].
GetOrgUserAuthTool @Summary 获取组织指定用户的所有已授权工具列表 @Description 获取组织指定用户的所有已授权工具列表 @Tags 管理系统 @Accept json @Produces json @Param roleId query string true "角色id" @Param orgId query string true "组织id" @Param userId query string true "用户id" @Router /api/org/user/tool [get].
GetOrgUserAuthToolRouter @Summary 获取组织指定用户的所有已授权工具下的所有路由树 @Description 获取组织指定用户的所有已授权工具下的所有路由树 @Tags 管理系统 @Accept json @Produces json @Param roleId query string true "角色id" @Param orgId query string true "组织id" @Param userId query string true "用户id" @Param toolId query string true "工具id" @Router /api/org/user/tool/router [get].
GetOrgUserList @Summary 获取组织下所有的用户列表 @Description 获取组织下所有的用户列表 @Tags 管理系统 @Produces json @Param args query OrgUserListArgs true "查询参数" @Router /api/org/user/list [get].
No description provided by the author
GetPhoneSecureCode @Summary 更新手机获取验证码 @Description 用户手机号,获取验证码接口 @Tags 用户接口 @Accept json @Produces json @Router /api/user/secure/update/phone/code [get].
No description provided by the author
No description provided by the author
GetSettings @Summary 获取用户设置 @Description 获取用户设置 @Tags 用户接口 @Accept json @Produces json @Param args body SettingsArgs true "请求体" @Router /api/settings [post].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InitRegisterUser 初始化注册用户 所有的初始化操作都基于默认root组织下的普通角色.
Login @Summary 用户登录 @Description 系统用户进行系统登陆 @Tags 用户接口 @Accept json @Param args body LoginArgs true "登录参数" @Produce json @Success 200 {object} resp.Response{code=int,data=any,msg=string} @Failure 500 {object} resp.Response{code=int,data=any,msg=string} @Router /public/login [post].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OrgRoleToolRouterList @Summary 获取角色已授权的工具栏对应的路由列表 @Description 获取角色已授权的工具栏对应的路由列表 @Tags 管理系统 @Accept json @Produces json @Param args body RoleAuthQuery true "请求体" @Router /api/role/tool/router/tree [get].
OrgUserRoleAuth @Summary 给组织的用户授权角色或取消授权角色 @Description 给组织的用户授权角色,默认情况下,分配授权角色就会获得角色授权有的授权,如需要取消某些授权,则需要手动处理取消.取消对应授权角色同时删除对应授权数据 @Tags 管理系统 @Accept json @Produces json @Param args body AuthArgs true "请求体" @Router /api/org/role/auth [post].
OrgUserRoleStatus @Summary 给组织的用户已授权的角色变更状态 @Description 给组织的用户已授权的角色变更状态,启用或禁用 @Tags 管理系统 @Accept json @Produces json @Param args body AuthArgs true "请求体" @Router /api/org/role/auth/status [post].
OrgUserRoleToolAuth @Summary 给组织用户的角色授权工具 @Description 给组织用户的角色授权工具 @Tags 管理系统 @Accept json @Produces json @Param args body AuthArgs true "请求体" @Router /api/org/role/auth/tool [post].
OrgUserRoleToolRoleAuth @Summary 给组织用户的角色的工具授权路由 @Description 给组织用户的角色的工具授权路由 @Tags 管理系统 @Accept json @Produces json @Param args body AuthArgs true "请求体" @Router /api/org/role/auth/tool/route [post].
OrgUserRoleToolStatus @Summary 给组织用户的角色授权工具 @Description 给组织用户的角色授权工具 @Tags 管理系统 @Accept json @Produces json @Param args body AuthArgs true "请求体" @Router /api/org/role/auth/tool/status [post].
PhoneCode @Summary 登录验证码 @Description 手机号获取登录验证码 @Tags 登录 @Accept json @Produce json @Success 200 {object} resp.Response{code=int,data=string,msg=string} @Failure 500 {object} resp.Response{code=int,data=any,msg=string} @Router /public/login_code [get].
PhoneLogin @Summary 手机登录 @Description 用户通过手机号登录系统 @Tags 登录 @Accept json @Param args body PhoneLoginArgs true "请求体" @Produce json @Success 200 {object} resp.Response{code=int,data=any,msg=string} @Failure 500 {object} resp.Response{code=int,data=any,msg=string} @Router /public/phone [post].
No description provided by the author
Register 注册用户 @Summary 注册用户 @Description 系统用户注册 @Tags 用户接口 @Accept json @Produce json @Param args body RegisterArgs true "请求体" @Success 200 {object} resp.Response{code=int,data=model.User} @Failure 500 {object} resp.Response{code=int,data=any} @Router /public/register [post].
ResetPassword @Summary 密码重置 @Description (手机号/邮箱号)重置密码 @Tags 登录 @Accept json @Produces json @Param args body ForGetArgs true "请求体" @Router /public/forget/reset [post].
UpdateAvatar @Summary 更新用户头像 @Description 更新用户头像 @Tags 用户接口 @Accept multipart/form-data @Param avatar formData file true "用户头像文件" @Produce json @Success 200 {object} resp.Response{code=int,data=any,msg=string} @Failure 500 {object} resp.Response{code=int,data=any,msg=string} @Router /api/user/update/avatar [post].
UpdateOrgInfo @Summary 更新组织信息 @Description 更新组织信息 @Tags 管理系统 @Accept json @Produces json @Param args body UpdateOrg true "查询参数" @Router /api/org/role/list [post].
UpdateOrgRole @Summary 设置指定组织的默认角色 @Description 用户修改指定组织的默认角色 @Tags 用户接口 @Accept json @Param args body UpdateUserOrgRole true "请求体" @Produce json @Success 200 {object} resp.Response{code=int,data=any,msg=string} @Failure 500 {object} resp.Response{code=int,data=any,msg=string} @Router /api/user/org/update/role [post].
No description provided by the author
UpdateSettings @Summary 更新用户设置 @Description 更新用户设置 @Tags 用户接口 @Accept json @Produces json @Param args body SettingsArgs true "请求体" @Router /api/settings/update [post].
No description provided by the author
UpdateUserEmail @Summary 更新用户邮箱 @Description 更新用户邮箱 @Tags 用户接口 @Accept json @Produces json @Param args body SecureArgs true "请求体" @Router /api/user/secure/update/email [post].
UpdateUserInfo @Summary 更新用户信息 @Description 更新用户信息 @Tags 用户接口 @Accept json @Param args body UpdateUserInfoArgs true "更新参数" @Produce json @Success 200 {object} resp.Response{code=int,data=any,msg=string} @Failure 500 {object} resp.Response{code=int,data=any,msg=string} @Router /api/user/update [post].
UpdateUserOrg @Summary 设置用户的默认组织 @Description 用户修改登录系统的默认组织,用户智能有一个默认组织 @Tags 用户接口 @Accept json @Param args body UpdateUserOrgArgs true "请求体" @Produce json @Success 200 {object} resp.Response{code=int,data=any,msg=string} @Failure 500 {object} resp.Response{code=int,data=any,msg=string} @Router /api/user/org/update/org [post].
UpdateUserPassword @Summary 更新用户密码 @Description 用户修改密码 @Tags 用户接口 @Accept json @Produces json @Param args body SecureArgs true "请求体" @Router /api/user/secure/update/password [post].
UpdateUserPhone @Summary 更新用户手机 @Description 修改用户手机号 @Tags 用户接口 @Accept json @Produces json @Param args body SecureArgs true "请求体" @Router /api/user/secure/update/phone [post].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

GPT_TOOL_ID 数据库初始化脚本中已经初始化 app_tool 表中.
No description provided by the author
ROOT_ORG_DEFAULT_ROLE 跟组织默认角色ID 数据库初始化脚本中已经初始化.
ROOT_ORG_ID 跟组织ID 数据库初始化脚本中已经初始化.

# Variables

No description provided by the author

# Structs

AuthArgs 无感权限更新请求参数,用于多个地方的无感操作,工具栏授权,工具栏路由授权.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author