Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:user_management_api [2020/11/26 17:45]
kkshin [BS2UserSettingEx]
en:user_management_api [2023/02/03 09:36] (current)
Line 42: Line 42:
     uint8_t numFingers;     uint8_t numFingers;
     uint8_t numFaces;     uint8_t numFaces;
-    uint8_t ​reserved2[1];+    uint8_t ​infoMask;
     uint32_t authGroupID;​     uint32_t authGroupID;​
     uint32_t faceChecksum;​     uint32_t faceChecksum;​
Line 70: Line 70:
 **7. //​numFaces//​** \\  **7. //​numFaces//​** \\ 
 Number of face templates mapped to user. \\ \\  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. \\  Not Used. \\ 
  
Line 80: Line 118:
 <WRAP tip 70%> <WRAP tip 70%>
 **Tip**\\ **Tip**\\
-Please use [[user management api#​BS2UserSettingEx|BS2UserSettingEx]] ​for <wrap em>​FaceStation F2</​wrap>​.+Please use [[user management api#​BS2UserSettingEx|BS2UserSettingEx]] ​to set <wrap em>the personal authentication mode</​wrap>​ of <wrap em>​FaceStation F2, BioStation 3</​wrap>​.
 </​WRAP>​ </​WRAP>​
 <code cpp> <code cpp>
Line 93: Line 131:
 </​code>​ </​code>​
 **1. //​startTime//​** \\  **1. //​startTime//​** \\ 
-Start time that a user can identify. ​When the value is 0, there are no limitations. \\ \\ +Start time that a user can identify. ​\\ 
 +<wrap em>​A ​value greater than 978307200 (01 January 2001, 00:​00:​00)</​wrap>​ must be entered, <wrap em>If set 0</​wrap>​it means that there is <wrap em>no limit</​wrap>​. \\ \\  
 **2. //​endTime//​** \\  **2. //​endTime//​** \\ 
-End time that that a user can identify. ​When the value is 0, there are no limitations \\ \\ +End time that that a user can identify. ​\\ 
 +<wrap em>​A ​value smaller than 1924991999 (31 December 2030, 23:​59:​59)</​wrap>​ must be entered, <wrap em>If set 0</​wrap>​it means that there is <wrap em>no limit</​wrap>​. \\ \\ 
 **3. //​fingerAuthMode//​** \\  **3. //​fingerAuthMode//​** \\ 
 Finger authentication mode for user authentication. \\  Finger authentication mode for user authentication. \\ 
Line 243: Line 284:
 Job code that will be allocated to user. \\ \\ Job code that will be allocated to user. \\ \\
 **10. //​phrase//​** \\  **10. //​phrase//​** \\ 
-Private message that will be displayed when the user authenticates. ​(only in FS2 FW 1.0.0 or higher) \\ \\ +Private message that will be displayed when the user authenticates. ​\\ 
 +<WRAP group 30%> 
 +^Model ​ ^Supported Ver.  ^ 
 +|FaceStation 2  |V1.0.0 or higher ​ | 
 +|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//​** \\  **11. //​accessGroupId//​** \\ 
 List of access groups where users belong to which can be configured up to 16 groups.\\ \\  List of access groups where users belong to which can be configured up to 16 groups.\\ \\ 
Line 319: Line 366:
 Job code that will be allocated to user. \\ \\ Job code that will be allocated to user. \\ \\
 **10. //​phrase//​** \\  **10. //​phrase//​** \\ 
-Private message that will be displayed when the user authenticates. ​(only in FS2 FW 1.0.0 or higher \\ \\+Private message that will be displayed when the user authenticates. ​\\ 
 +<WRAP group 30%> 
 +^Model ​ ^Supported Ver.  ^ 
 +|FaceStation 2  |V1.0.0 or higher  ​
 +|FaceStation F2  |V1.0.0 or higher ​ | 
 +|X-Station 2  |V1.0.0 or higher ​ | 
 +</​WRAP>​
 **11. //​accessGroupId//​** \\  **11. //​accessGroupId//​** \\ 
 List of access groups where users belong to which can be configured up to 16 groups.\\ \\  List of access groups where users belong to which can be configured up to 16 groups.\\ \\ 
Line 328: Line 381:
 <WRAP tip 70%> <WRAP tip 70%>
 **Tip**\\ **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>​FaceStation F2 and BioStation 3</​wrap>​.
-Please use [[user management api#​BS2UserSetting|BS2UserSetting]] <wrap em>other than</wrap> FaceStation F2.+
 </​WRAP>​ </​WRAP>​
 <code cpp> <code cpp>
Line 449: Line 501:
 Job code in T&A mode \\ \\  Job code in T&A mode \\ \\ 
 10. //phrase// \\  10. //phrase// \\ 
-Personal ​message displayed ​on the device UI when authentication(FS2 FW 1.0.0 or higher ​only) \\ \\+Private ​message ​that will be displayed when the user authenticates\\ 
 +<WRAP group 30%> 
 +^Model ​ ^Supported Ver.  ^ 
 +|FaceStation 2  |V1.0.0 or higher ​ | 
 +|FaceStation F2  |V1.0.0 or higher ​ | 
 +|X-Station 2  |V1.0.0 or higher ​ | 
 +</​WRAP>​
 11. //​accessGroupId//​ \\  11. //​accessGroupId//​ \\ 
 List of access group of the user assigned, maximum is 16. \\ \\  List of access group of the user assigned, maximum is 16. \\ \\ 
Line 457: Line 515:
 ''​FaceStation F2''​ Face template list for user authentication,​ there must be as many as **user.numFaces**. Refer to [[Face API]] for data format. \\ \\  ''​FaceStation F2''​ 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>​
 +
 +1. //​numUsers//​ \\
 +Number of registered users. \\ \\
 +2. //​numCards//​ \\
 +Number of registered cards. \\ \\
 +3. //​numFingerprints//​ \\
 +Number of fingerprints registered. \\ \\
 +4. //​numFaces//​ \\
 +Number of registered faces. \\ \\
 +5. //​numNames//​ \\
 +Number of registered user names. \\ \\
 +6. //​numImages//​ \\
 +Number of images registered. \\ \\
 +7. //​numPhrases//​ \\
 +Number of registered personal messages. \\ \\