GenAuth DocsDocuments
Concepts
User Guide
Development Integration
AgentAuth
Metadata
Development Integration
Multi-tenant (beta)
Console Documentation
Multi-tenant Console
Tenant Console
Saas Application Demo
Concepts
User Guide
Development Integration
AgentAuth
Metadata
Development Integration
Multi-tenant (beta)
Console Documentation
Multi-tenant Console
Tenant Console
Saas Application Demo
Old version
  • Single Page Web Application

  • Mobile and Client Applications

    • Android

      • Quick Start
      • Hosted Pages
      • Components

      • APIs

        • 核心认证 API
        • 标准协议 API
        • 多因素认证 API
        • 扫码认证 API
      • Social Login

      • Typical Scenarios

      • Private Deployment
      • Version History
    • C#

    • Flutter

    • iOS

    • React Native
  • Standard Web Application

  • Framework Integration

  • Others

  1. Development Integration
  2. /
  3. Mobile and Client Applications
  4. /
  5. Android
  6. /
  7. APIs
  8. /
  9. 扫码认证 API

¶ 扫码认证 API

Update time: 2025-07-23 07:34:21
Edit

要使用自建 App 扫码登录能力,请在 GenAuth 控制台勾选 "App 扫码登录" 选项。

当 Web 应用需要登录时,登录界面会显示一个可供 App 扫码的二维码,如下图:

二维码数据结构如下:

{
  "scene": "APP_AUTH",
  "random": "5e05f0c57fde537d950f7da5",
  "userPoolId": "5e04ae0d5f3cee22fb37612b",
  "createdAt": "2019-12-27T11:53:41.260Z",
  "expireAt": "2019-12-27T11:55:41.260Z"
}

在 App 侧,确保 App 处于登录状态,在需要授权登录时,依次调用下面 API

¶ 标记二维码

此接口调用成功后,网页的二维码上面会显示用户头像

注意:调用此接口前,App 必须处于登录状态

public static void markQRCodeScanned(String ticket, @NotNull AuthCallback<JSONObject> callback)

参数

  • ticket 二维码数据里面的 random 字段

示例

AuthClient.markQRCodeScanned(random, (code, message, data) -> {
    if (code == 200) {
        // notify user to authorize
    }
});

错误码

  • 500 无效二维码
  • 2020 未登录

¶ 确认二维码登录

使用二维码登录。分两步的好处是,App 可以在扫描之后给用户一个提示,待用户确认之后再登录。

注意:调用此接口之前必须先调用 标记二维码

public static void loginByScannedTicket(String ticket, @NotNull AuthCallback<JSONObject> callback)

参数

  • ticket 二维码数据里面的 random 字段

示例

AuthClient.loginByScannedTicket(random, (code, message, data) -> {
    if (code == 200) {
        // logged in
    }
});

错误码

  • 500 无效二维码
  • 2020 未登录

Previous article: 多因素认证 API Next article: Social Login
  • 标记二维码
  • 确认二维码登录

User identity management

Integrated third-party login
Customized authentication process

Enterprise internal management

Single sign-on
Multi-factor authentication
Permission management

Developer

Development Documentation
GitHub (opens new window)

Company

official@genauth.ai
16th Floor, Building B, Beichen Century Center, Chaoyang District, Beijing (Total)
Room 406, 4th Floor, Block B, No. 200, Tianfu Fifth Street, High-tech Zone, Chengdu (Branch)

© Beijing Steamory Technology Co., Ltd.