发起认证

应用发起身份认证请求，获取身份认证结果，从而访问受保护的系统/服务/应用的功能和数据（包括用户个人数据）。

接口说明

具体参数、返回值、错误码等描述，请参考对应的API文档。

用户身份认证控件介绍

系统提供了统一的用户认证控件供应用调用，使用用户认证控件的优势：

• 统一用户认证服务将通过该控件完成信息的识别和认证，再将认证结果返回给应用，整体过程安全可控，可以更好地保护用户的生物特征信息。

• 统一固定的UI组件样式，便于用户识别。

认证控件的样式如图所示，通过WidgetParam配置对应参数。

• 标注1：用户认证界面的标题（WidgetParam.title），最大长度为500字符。应用可在此配置符合场景的字符串。

• 标注2：导航按键上显示的文本（WidgetParam.navigationButtonText），最大长度为60字符。仅在单指纹、单人脸场景下支持配置。

  当生物认证失败后，将出现该按钮，点击后从生物认证切换到应用自定义认证。

• 如图所示，认证控件的显示形式（WidgetParam.windowMode）为弹窗。

  认证控件分为弹窗、全屏两种显示形式，如下图所示，左侧为默认的弹窗样式，右侧为全屏样式。

  当前仅系统应用可以选择和使用全屏类型的认证界面。

  

当前支持使用认证控件的认证类型包括：

• 锁屏密码认证

• 人脸认证

• 指纹认证

• 人脸+锁屏密码认证

• 指纹+锁屏密码认证

• 人脸+指纹+锁屏密码认证

说明： 当前仅在单指纹、单人脸场景下支持配置导航按键上显示的文本（WidgetParam.navigationButtonText）。

开发步骤

1. 申请权限：ohos.permission.ACCESS_BIOMETRIC。

2. 指定用户认证相关参数AuthParam（包括挑战值、认证类型UserAuthType列表和认证等级AuthTrustLevel）、配置认证控件界面WidgetParam，调用getUserAuthInstance获取认证对象。

3. 调用UserAuthInstance.on接口订阅认证结果。

4. 调用UserAuthInstance.start接口发起认证，通过IAuthCallback回调返回认证结果UserAuthResult。 当认证成功时返回认证通过类型（UserAuthType）和令牌信息（AuthToken）。

示例代码为发起用户认证，采用认证可信等级≥ATL3的人脸+锁屏密码认证，获取认证结果：

import type {BusinessError} from '@ohos.base';
import userIAM_userAuth from '@ohos.userIAM.userAuth';

// 设置认证参数
const authParam: userIAM_userAuth.AuthParam = {
  challenge: new Uint8Array([49, 49, 49, 49, 49, 49]),
  authType: [userIAM_userAuth.UserAuthType.PIN, userIAM_userAuth.UserAuthType.FACE],
  authTrustLevel: userIAM_userAuth.AuthTrustLevel.ATL3,
};
// 配置认证界面
const widgetParam: userIAM_userAuth.WidgetParam = {
  title: '请进行身份认证',
};
try {
  // 获取认证对象
  let userAuthInstance = userIAM_userAuth.getUserAuthInstance(authParam, widgetParam);
  console.log('get userAuth instance success');
  // 订阅认证结果
  userAuthInstance.on('result', {
    onResult(result) {
      console.log('userAuthInstance callback result = ' + JSON.stringify(result));
      // 可在认证结束或其他业务需要场景，取消订阅认证结果
      userAuthInstance.off('result');
    }
  });
  console.log('auth on success');
  userAuthInstance.start();
  console.log('auth start success');
} catch (error) {
  const err: BusinessError = error as BusinessError;
  console.log(`auth catch error. Code is ${err?.code}, message is ${err?.message}`);
}