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| -------- | -------- | 44| contextId | 上下文索引。 | 45| param | 认证方案[AuthSolution](_auth_solution_v10.md)。 | 46| scheduleInfos | 调度信息[ScheduleInfoV1_1](_schedule_info_v1__1_v11.md)。 | 47 48**返回：** 49 500 表示操作成功。 51 52非0 表示操作失败。 53 54 55### BeginEnrollmentV1_1() 56 57``` 58IUserAuthInterface::BeginEnrollmentV1_1 ([in] int userId, [in] unsigned char[] authToken, [in] struct EnrollParam param, [out] struct ScheduleInfoV1_1 info ) 59``` 60 61**描述** 62 63 64开始注册用户认证凭据。当注册凭据类型为口令且该用户已经注册了口令凭据时，将会更新口令凭据。 65 66**参数:** 67 68| 名称 | 描述 | 69| -------- | -------- | 70| userId | 用户ID。 | 71| authToken | 用户口令认证令牌。 | 72| param | 注册凭据参数[EnrollParam](_enroll_param_v10.md)。 | 73| info | 调度信息[ScheduleInfoV1_1](_schedule_info_v1__1_v11.md)。 | 74 75**返回：** 76 770 表示操作成功。 78 79非0 表示操作失败。 80 81 82### BeginIdentificationV1_1() 83 84``` 85IUserAuthInterface::BeginIdentificationV1_1 ([in] unsigned long contextId, [in] enum AuthType authType, [in] unsigned char[] challenge, [in] unsigned int executorSensorHint, [out] struct ScheduleInfoV1_1 scheduleInfo ) 86``` 87 88**描述** 89 90 91开始用户身份识别，并生成识别方案。 92 93**参数:** 94 95| 名称 | 描述 | 96| -------- | -------- | 97| contextId | 上下文索引。 | 98| authType | 用户身份识别类型AuthType}。 | 99| challenge | 随机挑战值，用于生成用户身份识别令牌，防止重放。 | 100| executorSensorHint | 执行器传感器提示，用于找到对应认证方式的传感器，值为0时表示没有指定传感器。 | 101| scheduleInfo | 调度信息[ScheduleInfoV1_1](_schedule_info_v1__1_v11.md)。 | 102 103**返回：** 104 1050 表示操作成功。 106 107非0 表示操作失败。 108 109 110### GetAllUserInfo() 111 112``` 113IUserAuthInterface::GetAllUserInfo ([out] UserInfo[] userInfos) 114``` 115 116**描述** 117 118 119获取所有用户信息. 120 121**参数:** 122 123| 名称 | 描述 | 124| -------- | -------- | 125| userInfos | 用户信息列表[UserInfo](_user_info_v11.md)。 | 126 127**返回：** 128 1290 表示操作成功。 130 131非0 表示操作失败。 132