从API版本26.0.0开始，用户认证服务新增伴随设备认证方式。用户可通过佩戴的伴随设备完成身份认证。
接口说明
具体参数、返回值、错误码等描述，请参考对应的@ohos.userIAM.userAuth (用户认证)。
| 接口名称 | 功能描述 |
|---|---|
| getUserAuthInstance(authParam: AuthParam, widgetParam: WidgetParam): UserAuthInstance | 获取UserAuthInstance对象，用于执行用户身份认证。发起伴随设备认证时，AuthParam的authType需指定为UserAuthType.COMPANION_DEVICE。 |
| on(type: 'result', callback: IAuthCallback): void | 订阅用户身份认证结果。 |
| off(type: 'result', callback?: IAuthCallback): void | 取消订阅用户身份认证结果。 |
| start(): void | 执行用户认证。 |
开发准备
-
申请权限：ohos.permission.ACCESS_BIOMETRIC。
-
指定用户认证相关参数AuthParam（包括挑战值、认证类型UserAuthType.COMPANION_DEVICE和认证等级AuthTrustLevel）、配置认证控件界面WidgetParam，调用getUserAuthInstance获取认证对象。
-
调用UserAuthInstance.on('result')接口订阅认证结果。
-
调用UserAuthInstance.start接口发起认证，通过IAuthCallback回调返回认证结果UserAuthResult。当认证成功时返回认证通过类型（UserAuthType）和令牌信息（AuthToken）。
示例
发起伴随设备认证，采用认证可信等级≥ATL2的伴随设备认证，获取认证结果。
companionDeviceAuthentication() {
try {
const randData = getRandData();
if (!randData) {
return;
}
// 设置认证参数
const authParam: userAuth.AuthParam = {
challenge: randData,
authType: [userAuth.UserAuthType.COMPANION_DEVICE],
authTrustLevel: userAuth.AuthTrustLevel.ATL2,
};
// 配置认证界面
const widgetParam: userAuth.WidgetParam = {
title: resourceToString($r('app.string.title')),
};
// 获取认证对象
const userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam);
Logger.info('get userAuth instance successfully.');
// 订阅认证结果
userAuthInstance.on('result', {
onResult: (result: userAuth.UserAuthResult) => {
try {
Logger.info('userAuthInstance callback.');
this.result[ResultIndex.EXAMPLE_1] = (`${result.result}`);
// 可在认证结束或其他业务需要场景，取消订阅认证结果。
userAuthInstance.off('result');
} catch (error) {
const err: BusinessError = error as BusinessError;
Logger.error(`onResult failed, code: ${err?.code}, Message: ${err?.message}`);
}
}
});
// 启动认证
userAuthInstance.start();
Logger.info('auth start successfully.');
} catch (error) {
const err: BusinessError = error as BusinessError;
Logger.error(`auth failed, code is ${err?.code}, message is ${err?.message}`);
}
}