LoCyanFrp API
v2
  • v2
  • v3
主站帮助文档
主站帮助文档
v2
  • v2
  • v3
    • 首页
    • 数据缓存
    • 鉴权说明
    • OAuth2.0 验证流程
    • 鉴权
      • OAuth
        • 获取访问令牌
    • 用户
      • 获取用户信息
        GET
      • 获取用户访问密钥
        GET
    • 隧道
      • 创建隧道
        POST
      • 删除隧道
        DELETE
      • 获取隧道列表
        GET
      • 获取单个隧道状态
        GET
      • 获取隧道配置文件
        GET
      • 强制下线隧道
        POST
      • 更新隧道信息
        POST
    • 签到
      • 获取签到状态
        GET
      • 签到
        POST
    • 通知
      • 获取公告
        GET
    • 节点
      • 列出全部可用节点
        GET
      • 获取节点统计信息
        GET
      • 获取随机隧道端口
        GET
    • 身份认证
      • 获取认证状态
        GET
    • ICP
      • 工信部
        • 获取验证码图片
        • 提交验证码点位获取人机验证 Sign
      • 添加 ICP 备案记录
        POST
      • 移除 ICP 备案记录
        DELETE
      • 获取已登记 ICP 备案列表
        GET
    • Minecraft
      • 获取 Minecraft 服务器状态
      • 获取 Minecraft 游戏连接信息
      • 创建 Minecraft 联机房间
      • 删除 Minecraft 联机房间
      • 获取用户全部 Minecraft 游戏
    • 软件
      • 获取 Frp 版本列表
    • 连接

    OAuth2.0 验证流程

    创建应用#

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

    申请授权#

    发起授权无需请求后端,引导用户访问请求授权终结点,并包含如下查询字符串:
    app_id: 应用 ID
    scopes: 需要申请的权限(多个使用逗号分隔)
    redirect_url: 重定向 URL,当用户同意或拒绝时将从此处回调
    对于重定向 URL,有一定的限制:
    重定向 URL 应由创建应用提交的 URL 起始
    应使用与创建应用提交 URL 相同层级
    举例子:
    以下是合法的 重定向 URL,它满足了如上两条条件
    若您想要重定向到本地服务,您可以使用如下重定向 URL 及并包含如下查询字符串参数:
    port: 本地服务端口
    ssl: 是否使用 SSL(HTTPS)
    path: 回调的路径
    https://dashboard.locyanfrp.cn/callback/auth/oauth/localhost
    请求授权的终结点为:
    https://dashboard.locyanfrp.cn/auth/oauth/authorize

    回调数据#

    同意授权#

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

    拒绝授权#

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

    获取访问令牌#

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

    访问资源#

    访问具有对应权限节点的接口获取资源
    修改于 2024-12-25 06:34:14
    上一页
    鉴权说明
    下一页
    获取访问令牌
    Built with