• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 查询支持的认证能力
2
3<!--Kit: User Authentication Kit-->
4<!--Subsystem: UserIAM-->
5<!--Owner: @WALL_EYE-->
6<!--Designer: @lichangting518-->
7<!--Tester: @jane_lz-->
8<!--Adviser: @zengyawen-->
9
10不同的设备对于认证能力(人脸、指纹、口令)的支持性各有差异,开发者在发起认证前应当先查询当前设备支持的用户认证能力。
11
12## 接口说明
13
14具体参数、返回值、错误码等描述,请参考对应的[API文档](../../reference/apis-user-authentication-kit/js-apis-useriam-userauth.md#userauthgetavailablestatus9)。
15
16| 接口名称 | 功能描述 |
17| -------- | -------- |
18| getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void | 根据指定的认证类型、认证等级,检测当前设备是否支持相应的认证能力。 |
19
20## 开发步骤
21
221. [申请权限](prerequisites.md#申请权限):ohos.permission.ACCESS_BIOMETRIC23
242. 指定认证类型([UserAuthType](../../reference/apis-user-authentication-kit/js-apis-useriam-userauth.md#userauthtype8))和认证等级([AuthTrustLevel](../../reference/apis-user-authentication-kit/js-apis-useriam-userauth.md#authtrustlevel8)),调用[getAvailableStatus](../../reference/apis-user-authentication-kit/js-apis-useriam-userauth.md#userauthgetavailablestatus9)接口查询当前的设备是否支持相应的认证能力。
25
26   认证可信等级的详细介绍请参见[认证可信等级划分原则](../../security/UserAuthenticationKit/user-authentication-overview.md#生物认证可信等级划分原则)。
27
28以查询设备是否支持认证可信等级≥ATL3的人脸认证功能为例:
29
30```ts
31import { BusinessError } from  '@kit.BasicServicesKit';
32import { userAuth } from '@kit.UserAuthenticationKit';
33
34// 查询认证能力是否支持。
35try {
36    userAuth.getAvailableStatus(userAuth.UserAuthType.FACE, userAuth.AuthTrustLevel.ATL3);
37    console.info('current auth trust level is supported');
38} catch (error) {
39    const err: BusinessError = error as BusinessError;
40    console.error(`current auth trust level is not supported. Code is ${err?.code}, message is ${err?.message}`);
41}
42```
43