1# IUserAuthInterface 2 3 4## 概述 5 6声明用户认证驱动的API接口。 7 8**起始版本：** 4.0 9 10**相关模块：**[HdfUserAuth](_hdf_user_auth_v11.md) 11 12 13## 汇总 14 15 16### Public 成员函数 17 18| 名称 | 描述 | 19| -------- | -------- | 20| [BeginEnrollmentV1_1](#beginenrollmentv1_1) ([in] int userId, [in] unsigned char[] authToken, [in] struct EnrollParam param, [out] struct [ScheduleInfoV1_1](_schedule_info_v1__1_v11.md) info) | 开始注册用户认证凭据。当注册凭据类型为口令且该用户已经注册了口令凭据时，将会更新口令凭据。 | 21| [BeginAuthenticationV1_1](#beginauthenticationv1_1) ([in] unsigned long contextId, [in] struct AuthSolution param, [out] struct [ScheduleInfoV1_1](_schedule_info_v1__1_v11.md)[] scheduleInfos) | 开始认证用户，并生成认证方案。 | 22| [BeginIdentificationV1_1](#beginidentificationv1_1) ([in] unsigned long contextId, [in] enum AuthType authType, [in] unsigned char[] challenge, [in] unsigned int executorSensorHint, [out] struct [ScheduleInfoV1_1](_schedule_info_v1__1_v11.md) scheduleInfo) | 开始用户身份识别，并生成识别方案。 | 23| [GetAllUserInfo](#getalluserinfo) ([out] [UserInfo](_user_info_v11.md)[] userInfos) | 获取所有用户信息. | 24 25 26## 成员函数说明 27 28 29### BeginAuthenticationV1_1() 30 31``` 32IUserAuthInterface::BeginAuthenticationV1_1 ([in] unsigned long contextId, [in] struct AuthSolution param, [out] struct ScheduleInfoV1_1[] scheduleInfos ) 33``` 34 35**描述** 36 37开始认证用户，并生成认证方案。 38 39**参数:** 40 41| 名称 | 描述 | 42| -------- | -------- | 43| contextId | 上下文索引。 | 44| param | 认证方案[AuthSolution](_auth_solution_v10.md)。 | 45| scheduleInfos | 调度信息[ScheduleInfoV1_1](_schedule_info_v1__1_v11.md)。 | 46 47**返回：** 48 490 表示操作成功。 50 51非0 表示操作失败。 52 53 54### BeginEnrollmentV1_1() 55 56``` 57IUserAuthInterface::BeginEnrollmentV1_1 ([in] int userId, [in] unsigned char[] authToken, [in] struct EnrollParam param, [out] struct ScheduleInfoV1_1 info ) 58``` 59 60**描述** 61 62开始注册用户认证凭据。当注册凭据类型为口令且该用户已经注册了口令凭据时，将会更新口令凭据。 63 64**参数:** 65 66| 名称 | 描述 | 67| -------- | -------- | 68| userId | 用户ID。 | 69| authToken | 用户口令认证令牌。 | 70| param | 注册凭据参数[EnrollParam](_enroll_param_v10.md)。 | 71| info | 调度信息[ScheduleInfoV1_1](_schedule_info_v1__1_v11.md)。 | 72 73**返回：** 74 750 表示操作成功。 76 77非0 表示操作失败。 78 79 80### BeginIdentificationV1_1() 81 82``` 83IUserAuthInterface::BeginIdentificationV1_1 ([in] unsigned long contextId, [in] enum AuthType authType, [in] unsigned char[] challenge, [in] unsigned int executorSensorHint, [out] struct ScheduleInfoV1_1 scheduleInfo ) 84``` 85 86**描述** 87 88开始用户身份识别，并生成识别方案。 89 90**参数:** 91 92| 名称 | 描述 | 93| -------- | -------- | 94| contextId | 上下文索引。 | 95| authType | 用户身份识别类型AuthType}。 | 96| challenge | 随机挑战值，用于生成用户身份识别令牌，防止重放。 | 97| executorSensorHint | 执行器传感器提示，用于找到对应认证方式的传感器，值为0时表示没有指定传感器。 | 98| scheduleInfo | 调度信息[ScheduleInfoV1_1](_schedule_info_v1__1_v11.md)。 | 99 100**返回：** 101 1020 表示操作成功。 103 104非0 表示操作失败。 105 106 107### GetAllUserInfo() 108 109``` 110IUserAuthInterface::GetAllUserInfo ([out] UserInfo[] userInfos) 111``` 112 113**描述** 114 115获取所有用户信息. 116 117**参数:** 118 119| 名称 | 描述 | 120| -------- | -------- | 121| userInfos | 用户信息列表[UserInfo](_user_info_v11.md)。 | 122 123**返回：** 124 1250 表示操作成功。 126 127非0 表示操作失败。 128