LoCyanFrp API
主站帮助文档
主站帮助文档
    • 首页
    • 鉴权说明
    • 鉴权验证流程
    • 鉴权
      • OAuth
        • 获取刷新令牌
        • 获取访问令牌
    • 用户
      • 获取用户信息
        GET
      • 获取用户访问密钥
        GET
    • 身份认证
      • 获取认证状态
        GET
    • 节点
      • 列出可用节点
        GET
      • 获取节点统计信息
        GET
      • 获取随机隧道端口
        GET
    • 隧道
      • 获取隧道列表
        GET
      • 获取隧道信息
        GET
      • 创建隧道
        PUT
      • 更新隧道信息
        PATCH
      • 批量更新隧道信息
        PATCH
      • 删除隧道
        DELETE
      • 批量删除隧道
        DELETE
      • 获取单个隧道状态
        GET
      • 获取多个隧道状态
        GET
      • 获取隧道配置文件
        GET
      • 强制下线隧道
        DELETE
      • 批量强制下线隧道
        DELETE
      • 获取隧道流量信息
        GET
    • 域名
      • 获取域名列表
        GET
    • 签到
      • 获取签到状态
      • 签到
    • 游戏
      • Minecraft
        • 获取 Minecraft 服务器状态
        • 获取用户全部 Minecraft 游戏
        • 获取 Minecraft 游戏连接信息
        • 创建 Minecraft 联机房间
        • 删除 Minecraft 联机房间
    • 软件
      • 获取 Frp 软件
      • 获取软件列表
      • 获取软件资产列表
    • 站点
      • 获取公告
    • 数据模型
      • 分页数据
      • 基本响应
    主站帮助文档
    主站帮助文档

    鉴权验证流程

    创建应用#

    前往 后台-OAuth2.0 应用 创建应用

    申请授权#

    发起授权无需请求后端,引导用户访问请求授权终结点,并包含如下查询字符串:
    client_id: 应用 ID
    scopes: 需要申请的权限(多个使用逗号分隔)
    redirect_uri: 重定向 URL,当用户同意或拒绝时将从此处回调(当模式为 code 时不需要填写)
    mode: 模式,支持 callback 与 code 两种模式,差异见下
    对于重定向 URL,有一定的限制:
    重定向 URL 应由创建应用提交的 URL 起始
    应使用与创建应用提交 URL 相同层级
    举例子:
    以下是合法的 重定向 URL,它满足了如上两条条件
    对于 callback 与 code 模式的不同:
    Callback 模式下,授权后将重定向到对应的重定向地址
    Code 模式下,授权后将返回一个一次性授权代码供用户复制以查询
    请求授权的终结点为:
    https://dashboard.locyanfrp.cn/auth/oauth/authorize

    回调数据#

    Callback 模式#

    同意授权#

    将包含如下查询字符串:
    refresh_token: 刷新令牌

    拒绝授权#

    将包含如下查询字符串:
    error: 错误类型

    获取访问令牌#

    Callback 模式#

    请求此端点获取访问令牌: 获取访问令牌
    如您需要重定向到动态端口的本地回调,可使用如下重定向 URL 终结点:
    https://dashboard.locyanfrp.cn/auth/oauth/redirect-localhost
    需要传入的查询字符串:
    port: 本地端口
    path: 本地路径
    ssl: 是否使用 SSL,默认为 false

    Code 模式#

    请求此端点获取刷新令牌: 获取刷新令牌
    请求此端点获取访问令牌: 获取访问令牌
    访问令牌具有时效性,有效期为 1小时
    应用可使用刷新令牌重新获取新的访问令牌,旧的访问令牌在刷新后会自动吊销

    访问资源#

    访问具有对应权限节点的接口获取资源
    修改于 2025-12-12 13:56:21
    上一页
    鉴权说明
    下一页
    获取刷新令牌
    Built with