跳到主要内容

Nebula Auth 接口信息

本文基于 nebula-auth-local 中当前已经实现的 Controller 整理，对外接口入口统一位于 /api/auth/**。

1. 登录与认证​

用户注册

创建一个新的平台用户账号，默认状态为启用。
POST/api/auth/register

用户登录

使用用户名与密码登录，登录成功后返回 accessToken 与 refreshToken。
POST/api/auth/login

刷新令牌

使用 refreshToken 换取新的登录结果。
POST/api/auth/refresh

获取认证初始化配置

返回前端登录页初始化所需的开关、注册策略和第三方登录可用性。
GET/api/auth/get-auth-config

获取当前登录用户

返回当前 accessToken 对应的用户上下文，包括角色、组织、权限编码与菜单列表。
GET/api/auth/current-user

用户登出

当前用户退出登录，也可以通过请求体显式指定 userId 和 cacheKey。
POST/api/auth/logout

分页查询在线用户

仅管理员或拥有全量权限的用户可调用，用于后台查看当前在线会话。
POST/api/auth/online-users/page

踢出在线用户

按 cacheKey 强制移除在线会话。
POST/api/auth/online-users/{cacheKey}/kick-out

2. 微信与 OAuth2 登录​

微信小程序登录

通过微信小程序 code 换取登录结果。
POST/api/auth/wechat/mini-program/login

准备微信网站跳转登录

生成 redirect 模式的微信授权地址和 state。
POST/api/auth/wechat/web/redirect/prepare

微信网站跳转登录回调

redirect 模式回调后完成登录并返回 token。
POST/api/auth/wechat/web/redirect/callback

创建微信网站扫码登录二维码

qr 模式下生成二维码登录链接、loginId 与过期时间。
POST/api/auth/wechat/web/qrcode

查询微信网站扫码登录状态

前端轮询扫码状态，可能返回 WAITING、SCANNED、SUCCESS、EXPIRED。
GET/api/auth/wechat/web/status

处理微信网站扫码登录回调

微信扫码回调入口，标记扫码状态并在成功后写入登录结果。
POST/api/auth/wechat/web/callback

3. 用户管理​

创建用户

创建后台用户，并可同时指定角色和组织。
POST/api/auth/users

更新用户

根据用户 ID 更新昵称、头像、联系方式、状态、角色和组织。
PUT/api/auth/users/{id}

获取用户详情

查询用户基础信息以及已绑定的角色与组织。
GET/api/auth/users/{id}

分页查询用户

按用户名、昵称、邮箱、手机号、状态筛选用户。
POST/api/auth/users/page

4. 角色与权限管理​

创建角色

创建角色定义。
POST/api/auth/roles

分页查询角色

按名称、编码、状态分页查询角色。
POST/api/auth/roles/page

查询所有角色

返回所有启用角色列表，适合表单下拉框初始化。
GET/api/auth/roles/list

创建授权

创建 USER / ROLE / ORG 对 MENU / BUTTON 的授权关系。
POST/api/auth/permissions

分页查询授权

分页查询授权记录。
POST/api/auth/permissions/page

5. 组织、菜单、按钮资源​

创建组织

创建组织节点，可形成公司 / 部门 / 小组的层级结构。
POST/api/auth/orgs

分页查询组织

按名称、编码、父节点和状态分页查询组织。
POST/api/auth/orgs/page

查询组织树

返回完整组织树结构。
GET/api/auth/orgs/tree

创建菜单

创建菜单资源，支持前端路由配置字段。
POST/api/auth/menus

分页查询菜单

分页查询根菜单，并返回子菜单树结构。
POST/api/auth/menus/page

查询菜单树

返回完整菜单树。
GET/api/auth/menus/tree

创建按钮

创建按钮资源，用于动作级权限控制。
POST/api/auth/buttons

分页查询按钮

分页查询按钮资源。
POST/api/auth/buttons/page

6. OAuth2 客户端与账户绑定管理​

创建 OAuth2 客户端

为第三方应用创建 OAuth2 客户端配置。
POST/api/auth/oauth2/clients

分页查询 OAuth2 客户端

分页查询 OAuth2 客户端配置。
POST/api/auth/oauth2/clients/page

创建 OAuth2 账户绑定

将本地用户与第三方账号建立绑定关系。
POST/api/auth/oauth2/accounts

分页查询 OAuth2 账户绑定

按用户和提供商分页查询第三方账号绑定。
POST/api/auth/oauth2/accounts/page