用户认证

说明： 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import userIAM_userAuth from '@ohos.userIAM.userAuth';

完整示例

// API version 6
import userIAM_userAuth from '@ohos.userIAM.userAuth';

export default {
    startAuth() {
        console.info("start auth");
        let auth = userIAM_userAuth.getAuthenticator();
        auth.execute("FACE_ONLY", "S2").then((code)= >{
            console.info("auth success");
            // 此处添加认证成功逻辑
        }).catch((code)= >{
            console.error("auth fail, code = " + code);
            // 此处添加认证失败逻辑
        });
    }
}

// API version 8
import userIAM_userAuth from '@ohos.userIAM.userAuth';
let auth = new userIAM_userAuth.UserAuth();

export default {
    getVersion() {
        console.info("start get version");
        let version = this.auth.getVersion();
        console.info("auth version = " + version);
    },

    startAuth() {
        console.info("start auth");
        this.auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
            onResult: (result, extraInfo) = > {
                try {
                    console.info("auth onResult result = " + result);
                    console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));
                    if (result == 'SUCCESS') {
                        // 此处添加认证成功逻辑
                    }  else {
                        // 此处添加认证失败逻辑
                    }
                } catch (e) {
                    console.info("auth onResult error = " + e);
                }
            },

            onAcquireInfo: (module, acquire, extraInfo) = > {
                try {
                    console.info("auth onAcquireInfo module = " + module);
                    console.info("auth onAcquireInfo acquire = " + acquire);
                    console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo));
                } catch (e) {
                    console.info("auth onAcquireInfo error = " + e);
                }
            }
        });
    },

    checkAuthSupport() {
        console.info("start check auth support");
        let checkCode = this.auth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
        if (checkCode == userIAM_userAuth.ResultCode.SUCCESS) {
            console.info("check auth support success");
            // 此处添加支持指定类型认证的逻辑
        } else {
            console.error("check auth support fail, code = " + checkCode);
            // 此处添加不支持指定类型认证的逻辑
        }
    },

    cancelAuth() {
        console.info("start cancel auth");
        // contextId通过auth接口获取
        let contextId = auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
            onResult: (result, extraInfo) = > {
                console.info("auth onResult result = " + result);
            },

            onAcquireInfo: (module, acquire, extraInfo) = > {
                console.info("auth onAcquireInfo module = " + module);
            }
        });
        let cancelCode = this.auth.cancel(contextId);
        if (cancelCode == userIAM_userAuth.Result.SUCCESS) {
            console.info("cancel auth success");
        } else {
            console.error("cancel auth fail");
        }
    }
}

userIAM_userAuth.getAuthenticator(deprecated)

getAuthenticator(): Authenticator

说明： 从 API Version 8 开始废弃，建议使用[constructor]替代。

获取Authenticator对象，用于执行用户身份认证。

需要权限 ：ohos.permission.ACCESS_BIOMETRIC

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

返回值：

类型	说明
[Authenticator]	认证器对象。

示例：

let authenticator = userIAM_userAuth.getAuthenticator();

Authenticator(deprecated)

说明： 从 API Version 8 开始废弃，建议使用[UserAuth]替代。

认证器对象。

execute(deprecated)

execute(type: string, level: string, callback: AsyncCallback): void

说明： 从 API Version 8 开始废弃，建议使用[auth]替代。

执行用户认证，使用callback方式作为异步方法。

需要权限 ：ohos.permission.ACCESS_BIOMETRIC

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
type	string	是	认证类型，当前只支持FACE_ONLY。 ALL为预留参数，当前版本暂不支持ALL类型的认证。
level	string	是	安全级别，对应认证的安全级别，有效值为S1（最低）、S2、S3、S4（最高）。具备3D人脸识别能力的设备支持S3及以下安全级别的认证。具备2D人脸识别能力的设备支持S2及以下安全级别的认证。
callback	AsyncCallback	否	回调函数。

callback返回值：

类型	说明
number	表示认证结果，参见[AuthenticationResult]。

示例：

authenticator.execute("FACE_ONLY", "S2", (code)= >{
    if (code == userIAM_userAuth.AuthenticationResult.SUCCESS) {
        console.info("auth success");
        return;
    }
    console.error("auth fail, code = " + code);
})

execute(deprecated)

execute(type:string, level:string): Promise

说明： 从 API Version 8 开始废弃，建议使用[auth]替代。

执行用户认证，使用promise方式作为异步方法。

需要权限 ：ohos.permission.ACCESS_BIOMETRIC

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
type	string	是	认证类型，当前只支持FACE_ONLY。 ALL为预留参数，当前版本暂不支持ALL类型的认证。
level	string	是	安全级别，对应认证的安全级别，有效值为S1（最低）、S2、S3、S4（最高）。具备3D人脸识别能力的设备支持S3及以下安全级别的认证。具备2D人脸识别能力的设备支持S2及以下安全级别的认证。

返回值：

类型	说明
Promise	返回携带一个number的Promise。number 为认证结果，参见[AuthenticationResult]。

示例：

let authenticator = userIAM_userAuth.getAuthenticator();
authenticator.execute("FACE_ONLY", "S2").then((code)= >{
    console.info("auth success");
}).catch((code)= >{
    console.error("auth fail, code = " + code);
});

AuthenticationResult(deprecated)

说明： 从 API Version 8 开始废弃，建议使用[ResultCode](替代。

表示认证结果的枚举。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称	默认值	描述
NO_SUPPORT	-1	设备不支持当前的认证方式。
SUCCESS	0	认证成功。
COMPARE_FAILURE	1	比对失败。
CANCELED	2	用户取消认证。
TIMEOUT	3	认证超时。
CAMERA_FAIL	4	开启相机失败。
BUSY	5	认证服务忙，请稍后重试。
INVALID_PARAMETERS	6	认证参数无效。
LOCKED	7	认证失败次数过多，已锁定。
NOT_ENROLLED	8	未录入认证凭据。
GENERAL_ERROR	100	其他错误。

UserAuth8+

认证器的对象。

constructor8+

constructor()

表示获取的认证器对象。

需要权限 ：ohos.permission.ACCESS_BIOMETRIC

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

返回值：

类型	说明
[UserAuth]	UserAuth认证器对象。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();

getVersion8+

getVersion() : number

表示获取的认证器版本信息。

需要权限 ：ohos.permission.ACCESS_BIOMETRIC

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

返回值：

类型	说明
number	获取的认证器版本信息。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
let version = auth.getVersion();
console.info("auth version = " + version);

getAvailableStatus8+

getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel) : number

表示检查指定的认证等级的认证能力是否可用。

需要权限 ：ohos.permission.ACCESS_BIOMETRIC

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
authType	[UserAuthType]	是	认证类型，当前只支持FACE。
authTrustLevel	[AuthTrustLevel]	是	认证结果的信任等级。

返回值：

类型	说明
number	获取指定的认证等级的认证能力是否可用的检查结果，返回值参见[ResultCode]。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
let checkCode = auth.getAvailableStatus(userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1);
if (checkCode == userIAM_userAuth.ResultCode.SUCCESS) {
    console.info("check auth support success");
    // 此处添加支持指定类型认证的逻辑
} else {
    console.error("check auth support fail, code = " + checkCode);
    // 此处添加不支持指定类型认证的逻辑
}

auth8+

auth(challenge: Uint8Array, authType: UserAuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array

表示执行用户认证，使用callback方式作为异步方法。

需要权限 ：ohos.permission.ACCESS_BIOMETRIC

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
challenge	Uint8Array	是	挑战值，可以填null。
authType	[UserAuthType]	是	认证类型，当前支持FACE。
authTrustLevel	[AuthTrustLevel]	是	信任等级。
callback	[IUserAuthCallback]	是	回调函数。

返回值：

类型	说明
Uint8Array	ContextId，作为取消认证[cancelAuth]接口的入参。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
    onResult: (result, extraInfo) = > {
        try {
            console.info("auth onResult result = " + result);
            console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));
            if (result == userIAM_userAuth.ResultCode.SUCCESS) {
                // 此处添加认证成功逻辑
            } else {
                // 此处添加认证失败逻辑
            }
        } catch (e) {
            console.info("auth onResult error = " + e);
        }
    }
});

cancelAuth8+

cancelAuth(contextID : Uint8Array) : number

表示通过contextID取消本次认证操作。

需要权限 ：ohos.permission.ACCESS_BIOMETRIC

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
contextID	Uint8Array	是	上下文ID信息，通过[auth]接口获得。

返回值：

类型	说明
number	取消本次认证操作的结果。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

// contextId可通过auth接口获取，此处直接定义
let contextId = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7]);
let cancelCode = auth.cancel(contextId);
if (cancelCode == userIAM_userAuth.ResultCode.SUCCESS) {
    console.info("cancel auth success");
} else {
    console.error("cancel auth fail");
}

IUserAuthCallback8+

认证过程中回调结果的对象。

onResult8+

onResult: (result : number, extraInfo : AuthResult) => void

表示在认证操作中，获取认证结果。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
result	number	是	认证结果，参见[ResultCode]。
extraInfo	[AuthResult]	是	扩展信息，不同情况下的具体信息，如果身份验证通过，则在extrainfo中返回用户认证令牌，如果身份验证失败，则在extrainfo中返回剩余的用户认证次数，如果身份验证执行器被锁定，则在extrainfo中返回冻结时间。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
    onResult: (result, extraInfo) = > {
        try {
            console.info("auth onResult result = " + result);
            console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));
            if (result == SUCCESS) {
                // 此处添加认证成功逻辑
            }  else {
                // 此处添加认证失败逻辑
            }
        } catch (e) {
            console.info("auth onResult error = " + e);
        }
    },

    onAcquireInfo: (module, acquire, extraInfo) = > {
        try {
            console.info("auth onAcquireInfo module = " + module);
            console.info("auth onAcquireInfo acquire = " + acquire);
            console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo));
        } catch (e) {
            console.info("auth onAcquireInfo error = " + e);
        }
    }
});

onAcquireInfo8+

onAcquireInfo ?: (module : number, acquire : number, extraInfo : any) => void

表示在认证过程中，获取提示码信息，非必须实现。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

参数：

参数名	类型	必填	说明
module	number	是	认证执行器的类型。
acquire	number	是	认证执行器认证过程的交互信息。
extraInfo	any	是	预留字段。

示例：

import userIAM_userAuth from '@ohos.userIAM.userAuth';

let auth = new userIAM_userAuth.UserAuth();
auth.auth(null, userIAM_userAuth.UserAuthType.FACE, userIAM_userAuth.AuthTrustLevel.ATL1, {
    onResult: (result, extraInfo) = > {
        try {
            console.info("auth onResult result = " + result);
            console.info("auth onResult extraInfo = " + JSON.stringify(extraInfo));
            if (result == SUCCESS) {
                // 此处添加认证成功逻辑
            }  else {
                // 此处添加认证失败逻辑
            }
        } catch (e) {
            console.info("auth onResult error = " + e);
        }
    },

    onAcquireInfo: (module, acquire, extraInfo) = > {
        try {
            console.info("auth onAcquireInfo module = " + module);
            console.info("auth onAcquireInfo acquire = " + acquire);
            console.info("auth onAcquireInfo extraInfo = " + JSON.stringify(extraInfo));
        } catch (e) {
            console.info("auth onAcquireInfo error = " + e);
        }
    }
});

AuthResult8+

表示认证结果的对象。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称	参数类型	必填	说明
token	Uint8Array	否	身份认证令牌。
remainTimes	number	否	剩余的认证操作次数。
freezingTime	number	否	认证操作的冻结时间。

ResultCode8+

表示执行结果的枚举。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称	默认值	描述
SUCCESS	0	执行成功。
FAIL	1	执行失败。
GENERAL_ERROR	2	操作通用错误。
CANCELED	3	操作取消。
TIMEOUT	4	操作超时。
TYPE_NOT_SUPPORT	5	不支持的认证类型。
TRUST_LEVEL_NOT_SUPPORT	6	不支持的认证等级。
BUSY	7	忙碌状态。
INVALID_PARAMETERS	8	无效参数。
LOCKED	9	认证器已锁定。
NOT_ENROLLED	10	用户未录入认证信息。

FaceTips8+

表示人脸认证过程中提示码的枚举。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称	默认值	描述
FACE_AUTH_TIP_TOO_BRIGHT	1	光线太强，获取的图像太亮。
FACE_AUTH_TIP_TOO_DARK	2	光线太暗，获取的图像太暗。
FACE_AUTH_TIP_TOO_CLOSE	3	人脸距离设备过近。
FACE_AUTH_TIP_TOO_FAR	4	人脸距离设备过远。
FACE_AUTH_TIP_TOO_HIGH	5	设备太高，仅获取到人脸上部。
FACE_AUTH_TIP_TOO_LOW	6	设备太低，仅获取到人脸下部。
FACE_AUTH_TIP_TOO_RIGHT	7	设备太靠右，仅获取到人脸右部。
FACE_AUTH_TIP_TOO_LEFT	8	设备太靠左，仅获取到人脸左部。
FACE_AUTH_TIP_TOO_MUCH_MOTION	9	在图像采集过程中，用户人脸移动太快。
FACE_AUTH_TIP_POOR_GAZE	10	没有正视摄像头。
FACE_AUTH_TIP_NOT_DETECTED	11	没有检测到人脸信息。

FingerprintTips8+

表示指纹认证过程中提示码的枚举。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称	默认值	描述
FINGERPRINT_AUTH_TIP_GOOD	0	获取的指纹图像良好。
FINGERPRINT_AUTH_TIP_DIRTY	1	由于传感器上可疑或检测到的污垢，指纹图像噪音过大。
FINGERPRINT_AUTH_TIP_INSUFFICIENT	2	由于检测到的情况，指纹图像噪声太大，无法处理。
FINGERPRINT_AUTH_TIP_PARTIAL	3	仅检测到部分指纹图像。
FINGERPRINT_AUTH_TIP_TOO_FAST	4	快速移动，指纹图像不完整。
FINGERPRINT_AUTH_TIP_TOO_SLOW	5	缺少运动，指纹图像无法读取。

UserAuthType8+

表示身份认证的凭据类型枚举。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称	默认值	描述
FACE	2	人脸认证。
FINGERPRINT	4	指纹认证。

AuthTrustLevel8+

表示认证结果的信任等级枚举。

系统能力 ：以下各项对应的系统能力均为SystemCapability.UserIAM.UserAuth.Core

名称	默认值	描述
ATL1	10000	认证结果的信任等级级别1。
ATL2	20000	认证结果的信任等级级别2。
ATL3	30000	认证结果的信任等级级别3。
ATL4	40000	认证结果的信任等级级别4。

审核编辑黄宇

声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。举报投诉

接口

接口

+关注

关注
33

文章
7963

浏览量
149211
鸿蒙

鸿蒙

+关注

关注
55

文章
2090

浏览量
42261

鸿蒙千帆起】《开心消消乐》完成鸿蒙原生应用开发，创新多端联动用户体验

更优质的用户体验，基于强大的 AI 能力还可以实现精准识别、精确投放，为伙伴提供新流量，并共享全场景服务分发，助力生态共赢。数据显示，截至今年 8 月份，鸿蒙生态的设备数已超过 7 亿，鸿蒙生态

发表于 01-03 10:22

鸿蒙实战项目开发：【短信服务】

数据管理电话服务分布式应用开发通知与窗口管理多媒体技术安全技能任务管理 WebGL 国际化开发应用测试 DFX面向未来设计鸿蒙系统移植和裁剪定制 …… 《

发表于 03-03 21:29

HarmonyOS应用开发-应用权限安全

HarmonyOS应用开发安全主要分为两个方面：应用权限和生物特征识别。应用权限严格按照权限分类分级模型进行定义，如图1所示，具体过程可分为三步：根据不同应用所需实现的功能，明确接口是否需要

发表于 09-23 14:26

用鸿蒙开发AI应用（汇总）连载中

的编译以及开发板程序烧录的功能...4. 用鸿蒙开发AI应用方案（四）Helloworld本篇编写了第一个鸿蒙程序，讲述了从源码到库，从库到组件，再从组件到应用，最后进入

发表于 01-13 15:03

华为鸿蒙认证测试题，你能答对几道？

大家好，我是老王~今天就来做几道鸿蒙OS测试题，看看有多少人拿到满分？（20道题，1题5分，答案展示在文末）答案▼ABBACCABBBABBAABAAABCDAAABD——————原创：老王丨【个人微信：spoto777；公众号：鸿蒙开

发表于 11-17 16:03

HDC2021技术分论坛：还有人不知道鸿蒙智联设备认证咋搞？

设计开发中最大限度地节约设计力量的有效方式。鸿蒙智联设备认证为此提供了灵活的继承认证策略供伙伴选择。举个例子来说，当伙伴有一款产品通过了认证

发表于 11-22 18:21

HDC2021技术分论坛：还有人不知道鸿蒙智联设备认证咋搞？

开发，且LTS版本的发布时间应不早于认证申请12个月。装载的OpenHarmony组件必须满足OpenHarmony PCS规范中规定的相应级别最小组件集要求。（3）系统安全测试：鸿蒙

发表于 11-23 17:15

鸿蒙JS开发接口请求loading怎么解决?

鸿蒙JS开发接口请求loading?

发表于 05-10 10:24

Harmony应用开发-用户头像认证实现

;}index.jsimport prompt from '@system.prompt';import userIAM_userAuth from '@ohos.userIAM.userAuth';export

发表于 05-19 10:13

SystemReady安全接口扩展用户指南

本指南为Arm System Read 安全接口扩展提供总体的认证和测试流程概览。 Arm Ready System Ready 是一套标准和合规认证程序。 System Ready

发表于 08-08 07:44

鸿蒙智联生态设备认证与模组认证关系

2021年10月22日~24日，华为将在中国松山湖举行2021华为开发者大会，聚焦鸿蒙系统、智能家居、智慧办公、HMS Core 等热门话题，与华为专家、行业大咖、全球开发者一起探讨全场景智慧

发表于 10-23 16:07 •1953次阅读

鸿蒙之@ohos.bundle.defaultAppManager (默认应用管理)

本模块提供查询默认应用的能力，支持查询当前应用是否是默认应用。说明本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。导入模块

发表于 02-20 17:29 •315次阅读

润开鸿多名讲师获首批“鸿蒙原生应用开发培训讲师”资格认证

近日，鸿蒙生态服务（深圳）有限公司（以下简称“鸿蒙生态服务公司”）成功举办了国内首批“鸿蒙原生应用开发培训讲师”认证活动。在此次

发表于 03-15 11:28 •624次阅读

国内首批 | 开鸿智谷多名讲师获“鸿蒙原生应用开发培训讲师”资格认证

2023年3月4日-5日，鸿蒙生态服务（深圳）有限公司（以下简称“鸿蒙生态服务公司”）组织了国内首批“鸿蒙原生应用开发培训讲师”认证，开鸿智

发表于 03-16 08:29 •275次阅读

人才储备再升级！软通动力子公司鸿湖万联多名讲师荣获首批“鸿蒙原生应用开发培训讲师”认证

近日，由鸿蒙生态服务公司组织开展的国内首批“鸿蒙原生应用开发培训讲师”认证顺利完成。作为此次认证的重要参与者，鸿湖万联申报的四位

发表于 03-25 10:25 •420次阅读

搜索历史

鸿蒙开发接口安全：【@ohos.userIAM.userAuth (用户认证)】

用户认证

导入模块

完整示例

userIAM_userAuth.getAuthenticator(deprecated)

Authenticator(deprecated)

execute(deprecated)

execute(deprecated)

AuthenticationResult(deprecated)

UserAuth8+

constructor8+

getVersion8+

getAvailableStatus8+

auth8+

cancelAuth8+

IUserAuthCallback8+

onResult8+

onAcquireInfo8+

AuthResult8+

ResultCode8+

FaceTips8+

FingerprintTips8+

UserAuthType8+

AuthTrustLevel8+

评论