Authentication Auth

The Auth API provides user authentication, sign-in, biometrics, and other security-related capabilities.

Try it online

getUserProfilerequestSSOLogin

BiometricrequestAuthorizationToken

Results will appear below

Auth API demo

Mock results for user profile, SSO, biometric authentication, and authorization token

Vue

<script setup>
import { ref } from 'vue'
import woo from 'mini-sdk'

const profile = ref(null)

async function login() {
  woo.showLoading('登录中...')
  try {
    const { code } = await woo.requestSSOLogin()
    const res = await woo.request.post('/api/auth/login', { code })
    await woo.setStorage({ key: 'token', data: res.data.token })
    profile.value = await woo.getUserProfile()
    woo.showToast({ title: '登录成功', icon: 'success' })
  } finally {
    woo.hideLoading()
  }
}
</script>

<template>
  <div v-if="profile">{{ profile.nickname }}</div>
  <button v-else @click="login">SSO 登录</button>
</template>

React

import { useState } from 'react'
import woo from 'mini-sdk'

function LoginPage() {
  const [profile, setProfile] = useState(null)

  async function login() {
    woo.showLoading('登录中...')
    try {
      const { code } = await woo.requestSSOLogin()
      const res = await woo.request.post('/api/auth/login', { code })
      await woo.setStorage({ key: 'token', data: res.data.token })
      setProfile(await woo.getUserProfile())
      woo.showToast({ title: '登录成功', icon: 'success' })
    } finally {
      woo.hideLoading()
    }
  }

  return (
    <>
      {profile ? <div>{profile.nickname}</div> : <button onClick={login}>SSO 登录</button>}
    </>
  )
}

Import

import woo from 'mini-sdk'
// 或
import { auth } from 'mini-sdk'

API reference

requestSSOLogin

Start SSO (single sign-on) login.

const result = await woo.requestSSOLogin()

Return value SSOLoginResult:

Field	Type	Description
code	string	Authorization code
state	string	State token

ACK mechanism

SSO login is interactive. When the host receives the request, it first sends ack, and the SDK automatically extends the timeout to 5 minutes so the flow does not time out while the user is acting.

---

requestLinkedLogin

Start linked (identity provider) login.

const result = await woo.requestLinkedLogin({
  provider: 'wechat',
  scope: 'basic',
})

---

submitAccountLink

Submit account linking.

await woo.submitAccountLink({
  provider: 'phone',
  credential: '+86138xxxx1234',
  verificationCode: '123456',
})

---

unlinkAccount

Unlink a linked account.

await woo.unlinkAccount({ provider: 'wechat' })

---

authenticateWithBiometric

Start biometric authentication (fingerprint / Face ID).

try {
  const result = await woo.authenticateWithBiometric({
    reason: '请验证身份以完成支付',
  })
  console.log('认证成功', result)
} catch (err) {
  if (err.code === BridgeErrorCode.BiometricCancelled) {
    console.log('用户取消了认证')
  }
}

cancelBiometricAuthentication

Cancel biometric authentication in progress.

await woo.cancelBiometricAuthentication()

---

requestAuthorizationToken

Request an authorization token.

const result = await woo.requestAuthorizationToken({
  scope: 'user:read',
})
console.log(result.token)

---

getUserProfile

Get user profile data.

const profile = await woo.getUserProfile()
console.log(profile.nickname, profile.avatar)

Full example: sign-in flow

Vue

<script setup>
import woo from 'mini-sdk'
import { BridgeErrorCode } from 'mini-sdk'

async function login() {
  woo.showLoading('登录中...')

  try {
    // 1. SSO 登录获取授权码
    const { code } = await woo.requestSSOLogin()

    // 2. 用授权码换取 Token
    const res = await woo.request.post('/api/auth/login', { code })
    const { token } = res.data

    // 3. 保存 Token
    await woo.setStorage({ key: 'token', data: token })

    // 4. 获取用户信息
    const profile = await woo.getUserProfile()
    await woo.setStorage({ key: 'profile', data: profile })

    woo.showToast({ title: '登录成功', icon: 'success' })
    woo.reLaunch('/pages/index/index')
  } catch (err) {
    if (err.code === BridgeErrorCode.UserCancelled) {
      woo.showToast({ title: '已取消登录', icon: 'none' })
    } else {
      woo.showToast({ title: '登录失败', icon: 'none' })
    }
  } finally {
    woo.hideLoading()
  }
}
</script>

React

import { useCallback } from 'react'
import woo from 'mini-sdk'
import { BridgeErrorCode } from 'mini-sdk'

function LoginFlow() {
  const login = useCallback(async () => {
    woo.showLoading('登录中...')

    try {
      const { code } = await woo.requestSSOLogin()
      const res = await woo.request.post('/api/auth/login', { code })
      const { token } = res.data
      await woo.setStorage({ key: 'token', data: token })
      const profile = await woo.getUserProfile()
      await woo.setStorage({ key: 'profile', data: profile })
      woo.showToast({ title: '登录成功', icon: 'success' })
      woo.reLaunch('/pages/index/index')
    } catch (err) {
      if (err.code === BridgeErrorCode.UserCancelled) {
        woo.showToast({ title: '已取消登录', icon: 'none' })
      } else {
        woo.showToast({ title: '登录失败', icon: 'none' })
      }
    } finally {
      woo.hideLoading()
    }
  }, [])

  return <button onClick={login}>登录</button>
}

Type definitions

interface SSOLoginResult {
  code: string
  state: string
}

interface LinkedLoginOptions {
  provider: string
  scope?: string
}

interface LinkedLoginResult {
  token: string
}

interface SubmitAccountLinkOptions {
  provider: string
  credential: string
  verificationCode?: string
}

interface BiometricOptions {
  reason?: string
}

interface BiometricResult {
  success: boolean
}

interface RequestAuthorizationTokenOptions {
  scope: string
}

interface AuthTokenResult {
  token: string
  expiresIn: number
}

interface UserProfile {
  nickname: string
  avatar: string
  [key: string]: unknown
}

Quick reference

Method	Description	Signature
login	Start sign-in	() → Promise<{ code }>
checkSession	Check whether the session is still valid	() → Promise<{ valid }>
getUserInfo	Get user information	() → Promise<UserInfo>
getUserProfile	Get user information (with popup consent)	({ desc }) → Promise<UserInfo>
authorize	Request a permission explicitly	({ scope }) → Promise<void>
getSetting	Get the list of granted permissions	() → Promise<{ authSetting }>
openSetting	Open the permission settings page	() → Promise<{ authSetting }>