Differences

This shows you the differences between two versions of the page.

--- en:user_management_api [2022/04/11 11:14]
127.0.0.1 external edit
+++ en:user_management_api [2024/05/28 18:32] (current)
kkshin [BS2UserFaceExBlob]
@@ Line 23: / Line 23: @@
   * [[BS2_GetUserSmallDatas]]: [+ 2.6.3] Gets selected data of user with efficient use of memory.
   * [[BS2_GetUserSmallDatasEx]]: [+ 2.6.3] Gets selected data of user with efficient use of memory.
-  * [[BS2_EnrollUserFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Enrolls new user.
+  * [[BS2_EnrollUserFaceEx]]: [+ 2.7.1] ''Visual Face Support'' Enrolls new user.
-  * [[BS2_GetUserInfosFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Gets the user information of the given user ID.
+  * [[BS2_GetUserInfosFaceEx]]: [+ 2.7.1] ''Visual Face Support'' Gets the user information of the given user ID.
-  * [[BS2_GetUserDatasFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Gets selected data of user.
+  * [[BS2_GetUserDatasFaceEx]]: [+ 2.7.1] ''Visual Face Support'' Gets selected data of user.
+  * [[BS2_PartialUpdateUser]]: [+ 2.8.3] Updates partial information of an already registered user.
+  * [[BS2_PartialUpdateUserEx]]: [+ 2.8.3] Updates partial information of an already registered user. (including Job code and User phrase)
+  * [[BS2_PartialUpdateUserSmall]]: [+ 2.8.3] Updates partial information of an already registered user with efficient use of memory.
+  * [[BS2_PartialUpdateUserSmallEx]]: [+ 2.8.3] Updates partial information of an already registered user with efficient use of memory.
+  * [[BS2_PartialUpdateUserFaceEx]]: [+ 2.8.3] ''Visual Face Support'' Updates partial information of an already registered user.
+  * [[BS2_GetUserStatistic]]: [+ 2.8.3] Gets the user-related statistics that the device has.
@@ Line 42: / Line 48: @@
     uint8_t numFingers;
     uint8_t numFaces;
-    uint8_t reserved2[1];
+    uint8_t infoMask;
     uint32_t authGroupID;
     uint32_t faceChecksum;
@@ Line 70: / Line 76: @@
 **7. //numFaces//** \\
 Number of face templates mapped to user. \\ \\
-**8. //authGroupID//** \\
+**8. //infoMask//** \\
-ID of group when face group matching is enabled. \\ \\
+[+ 2.8.3] This indicates what information the user has. By changing the information at infoMask and sending the information to change to the device, it is possible to partially change the selected user’s information. \\
-**9. //faceChecksum//** \\
+At this moment, Partial Update families of functions([[BS2_PartialUpdateUser]], [[BS2_PartialUpdateUserEx]], [[BS2_PartialUpdateUserSmall]], [[BS2_PartialUpdateUserSmallEx]], [[BS2_PartialUpdateUserFaceEx]]) and user mask argument must match (refer to the table below). \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0x01  |BS2_USER_INFO_MASK_PHRASE  |
+|0x02  |BS2_USER_INFO_MASK_JOB_CODE  |
+|0x04  |BS2_USER_INFO_MASK_NAME  |
+|0x08  |BS2_USER_INFO_MASK_PHOTO  |
+|0x10  |BS2_USER_INFO_MASK_PIN  |
+|0x20  |BS2_USER_INFO_MASK_CARD  |
+|0x40  |BS2_USER_INFO_MASK_FINGER  |
+|0x80  |BS2_USER_INFO_MASK_FACE  |
+</WRAP>
+**''Get user information''** \\
+The infoMask indicates what information is allocated to the current user when getting the user information. \\ \\
+<WRAP group 50%>
+^User information  ^BS2_USER_MASK  ^infoMask  ^
+|Partial removal  |unmasking  |unmasking  |
+|Partial edit  |masking  |masking  |
+|Default setting  |unmasking  |masking  |
+</WRAP>
+**''Partial removal of user information''** \\
+Choose unmasking for the information to be removed at all sections (infoMask, Partial Update families of functions, and user mask agreements). \\ \\
+**''Partial edit of user information''** \\
+Choose masking for the information to be edited at all sections (infoMask, Partial Update families of functions, and user mask agreements). \\ \\
+**''Default setting of user information''** \\
+Choose masking for infoMask and unmasking for Partial Update familes of functions and user mask agreements. \\ \\
+**''Changing credential information (Card/Fingerprint/Face)''** \\
+It checks if the credential information is allocated or not such as [numCards, numFingers, or numFaces is 0], [fingerObjs, cardObjs, faceObjs, or faceExObjs is NULL]. Plus, it checks infoMask. \\
+If the input information at card/fingerprint/face is greater than 0 and the mask at infoMask is set, the device credential information can be changed. \\
+For example, when the device has two fingerprints for a user, select masking at infoMask’s BS2_USER_INFO_MASK_FINGER, numFingers =1, and assign a fingerprint at fingerObjs. Then the device will have only one newly assigned fingerprint. \\
+To add a new fingerprint, three fingerprints must be assigned which includes the two previously stored fingerprints and the new fingerprint. \\ \\
+**''Keeping the credential information (Card/Fingerprint/Face)''** \\
+The device keeps the original credential information if the credential information at card/fingerprint/face is set to 0 and the infoMask is set to masking. \\ \\
+**''Removing the credential information (Card/Fingerprint/Face)''** \\
+If the credential information at card/fingerprint/face is set to 0 and the infoMask is set to unmasking, the device erases the corresponding information assigned to each credential. \\ \\
+**9. //authGroupID//** \\
+The group ID the user is assigned to when face group matching is enabled. \\ \\
+**10. //faceChecksum//** \\
 Not Used. \\
@@ Line 80: / Line 124: @@
 <WRAP tip 70%>
 **Tip**\\
-<wrap em>Other than FaceStation F2</wrap> \\
+Please use [[user management api#BS2UserSettingEx|BS2UserSettingEx]] to set <wrap em>the personal authentication mode</wrap> for <wrap em>Visual Face-based devices</wrap>.
-Please use [[user management api#BS2UserSettingEx|BS2UserSettingEx]] for <wrap em>FaceStation F2</wrap>.
 </WRAP>
 <code cpp>
@@ Line 253: / Line 296: @@
 |FaceStation F2  |V1.0.0 or higher  |
 |X-Station 2  |V1.0.0 or higher  |
+|BioStation 3  |V1.0.0 or higher  |
 </WRAP>
 **11. //accessGroupId//** \\
@@ Line 343: / Line 387: @@
 <WRAP tip 70%>
 **Tip**\\
-<wrap em>FaceStation F2 Only</wrap>  \\
+Please use [[user management api#BS2UserSetting|BS2UserSetting]] to set <wrap em>the personal authentication mode</wrap> for devices other than <wrap em>Visual Face-based devices</wrap>.
-Please use [[user management api#BS2UserSetting|BS2UserSetting]] <wrap em>other than</wrap> FaceStation F2.
 </WRAP>
 <code cpp>
@@ Line 460: / Line 503: @@
 Fingerprint template list for user authentication, there must be as many as **user.numFingers**. Refer to [[Fingerprint API]] for data format. \\ \\
 . //faceObjs// \\
-''FaceStation2'', ''FaceLite'' Face template list for user authentication, there must be as many as **user.numFaces**. Refer to [[Face API]] for data format. \\ \\
+''IR Face supported'' Face template list for user authentication, there must be as many as **user.numFaces**. Refer to [[Face API]] for data format. \\ \\
 . //job// \\
 Job code in T&A mode \\ \\
@@ Line 474: / Line 517: @@
 List of access group of the user assigned, maximum is 16. \\ \\
 . //settingEx// \\
-''FaceStation F2'' Sets private authentication. It is now possible to combine more various authentication modes by combining fingerprints and faces. \\ \\
+''Visual Face supported'' Sets private authentication. It is now possible to combine more various authentication modes by combining fingerprints and faces. \\ \\
 . //faceExObjs// \\
-''FaceStation F2'' Face template list for user authentication, there must be as many as **user.numFaces**. Refer to [[Face API]] for data format. \\ \\
+''Visual Face supported'' Face template list for user authentication, there must be as many as **user.numFaces**. Refer to [[Face API]] for data format. \\ \\
+==== BS2UserStatistic ====
+<code cpp>
+typedef struct {
+    uint32_t numUsers;
+    uint32_t numCards;
+    uint32_t numFingerprints;
+    uint32_t numFaces;
+    uint32_t numNames;
+    uint32_t numImages;
+    uint32_t numPhrases;
+} BS2UserStatistic;
+</code>
+. //numUsers// \\
+Number of registered users. \\ \\
+. //numCards// \\
+Number of registered cards. \\ \\
+. //numFingerprints// \\
+Number of fingerprints registered. \\ \\
+. //numFaces// \\
+Number of registered faces. \\ \\
+. //numNames// \\
+Number of registered user names. \\ \\
+. //numImages// \\
+Number of images registered. \\ \\
+. //numPhrases// \\
+Number of registered personal messages. \\ \\