¶ APP Full Interface List For APP QR Code Login

Authing provides a REST-based QR code login interface, which developers can call directly.

¶ Generate QR code

{
  "code": 200,
  "data": {
    "random": "SzZrszCJNCFfVBDUCKLDtAYNBR96SK",
    "expiresIn": 120,
    "url": "https://files.authing.co/user-contentsqrcode/5fae2648201cfd526f0ec354/SzZrszCJNCFfVBDUCKLDtAYNBR96SK.png"
  }
}

Example of generated QR code:

Use the online QR code decoding tool (opens new window) to view the QR code data as follows:

{
  "scene": "APP_AUTH",
  "random": "SzZrszCJNCFfVBDUCKLDtAYNBR96SK",
  "userPoolId": "5fae2648201cfd526f0ec354",
  "createdAt": "2020-11-13T06:23:25.396Z",
  "expiresIn": 120,
  "customData": {}
}

¶ Query the status of the QR code

{
  "code": 200,
  "message": "Query the QR code status successfully！",
  "data": {
    "random": "SzZrszCJNCFfVBDUCKLDtAYNBR96SK",
    "userInfo": {},
    "status": 0,
    "ticket": null,
    "scannedUserId": null
  }
}

Request result field description:

• status
  • 0: The code is not scanned.
  • 1: The QR code has been scanned but the user has not clicked to agree to authorize or cancel authorization. At this time, the user's avatar and nickname will be returned, but it does not contain other confidential information, which can be used for front-end avatar display.
  • 2: User agrees to authorization
  • 3: User cancels authorization
  • -1: Expired
• userInfo:
  • By default, after the user scans the code, it will contain two fields: nickname and photo
  • Developers can also configure to return complete user information (including login credentials token)
• ticket: used in getting complete user information. **This field will only appear after the user agrees to the authorization. **See below for details.

¶ To get user information by ticket

{
  "code": 200,
  "message": "换取用户信息成功",
  "data": {
    "id": "5e05bbf2d51b3761d5c71070",
    "email": "983132@qq.com",
    "emailVerified": false,
    "oauth": "",
    "username": "983132@qq.com",
    "nickname": "",
    "company": "",
    "photo": "https://usercontents.authing.co/authing-avatar.png",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImVtYWlsIjoiOTgzMTMyQHFxLmNvbSIsImlxxxxxxxxx",
    "phone": "",
    "tokenExpiredAt": "2020-01-11T08:08:18.000Z",
    "loginsCount": 1,
    "lastIp": "::1",
    "signedUp": "2019-12-27T08:08:18.115Z",
    "blocked": false,
    "isDeleted": false
  }
}

¶ Mark the code scanned on APP

{
    code: 200,
    message: "QR code scanning confirmed successfully",
    data: {
        random: "", // Return as it was before
        status: 0,
        description: "xxxx",
    }
}

¶ Agrees to authorization on APP

{
    code: 200,
    message: "Authorized login succeeded",
    data: {
        random: "", // Return as it was before
        status: 1,
        description: "xxxx",
    }
}

¶ Cancel authorization on APP

{
    code: 200,
    message: "Cancel authorization successfully",
    data: {
        random: "", // Return as it was before
        status: -1,
        description: "xxxx",
    }
}