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
Next revision Both sides next revision
en:user_management_api [2019/05/27 16:09]
yjjung [BS2UserSmallBlob] 		en:user_management_api [2022/04/11 11:14]
127.0.0.1 external edit
Line 9: Line 9:
   * [[BS2_RemoveAllUser]]:​ Deletes all users.   * [[BS2_RemoveAllUser]]:​ Deletes all users.
   * [[BS2_GetUserInfos]]:​ Gets the user information of the given user ID.   * [[BS2_GetUserInfos]]:​ Gets the user information of the given user ID.
-  * [[BS2_GetUserInfosEx]]:​ Gets the user information of the given user ID. ([+ 2.4.0] ​including Job code and User phrase)+  * [[BS2_GetUserInfosEx]]: ​[+ 2.4.0] ​Gets the user information of the given user ID. (including Job code and User phrase)
   * [[BS2_EnrolUser]]:​ Enrolls new user.   * [[BS2_EnrolUser]]:​ Enrolls new user.
-  * [[BS2_EnrolUserEx]]: ​Enrolls new user. ([+ 2.4.0] including Job code and User phrase) +  * [[BS2_EnrolUserEx]]:​ [+ 2.4.0] ​Enrolls new user. (including Job code and User phrase) 
-  * [[BS2_EnrolUser]]: [+ 2.6.3] Enrolls new user. +  * [[BS2_EnrollUser]]: [+ 2.6.3] Enrolls new user. 
-  * [[BS2_EnrolUserEx]]: [+ 2.6.3] Enrolls new user. (including Job code and User phrase) +  * [[BS2_EnrollUserEx]]: [+ 2.6.3] Enrolls new user. (including Job code and User phrase) 
-  * [[BS2_GetUserDatas]]:​​ Gets selected data of user. (+ [2.5.0]) +  * [[BS2_GetUserDatas]]:​​ Gets selected data of user. 
-  * [[BS2_GetUserDatasEx]]:​​ ​Gets selected data of user. ([+ 2.5.0] including Job code, User phrase)+  * [[BS2_GetUserDatasEx]]:​​ [+ 2.5.0] ​Gets selected data of user. (including Job code, User phrase)
   * [[BS2_GetSupportedUserMask]]:​ Gets user settings supported by the device.   * [[BS2_GetSupportedUserMask]]:​ Gets user settings supported by the device.
   * [[BS2_EnrollUserSmall]]:​ [+ 2.6.3] Enrolls new user with efficient use of memory.   * [[BS2_EnrollUserSmall]]:​ [+ 2.6.3] Enrolls new user with efficient use of memory.
   * [[BS2_EnrollUserSmallEx]]:​ [+ 2.6.3] Enrolls new user with efficient use of memory.   * [[BS2_EnrollUserSmallEx]]:​ [+ 2.6.3] Enrolls new user with efficient use of memory.
-  * [[BS2_GetUserSmallInfos]]:​ [+ 2.6.3] Gets the user information of the given user ID with efficient use of memory +  * [[BS2_GetUserSmallInfos]]:​ [+ 2.6.3] Gets the user information of the given user ID with efficient use of memory. 
-  * [[BS2_GetUserSmallInfosEx]]:​ [+ 2.6.3] Gets the user information of the given user ID with efficient use of memory+  * [[BS2_GetUserSmallInfosEx]]:​ [+ 2.6.3] Gets the user information of the given user ID with efficient use of memory.
   * [[BS2_GetUserSmallDatas]]:​ [+ 2.6.3] Gets selected data of user with efficient use of memory.   * [[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_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_GetUserInfosFaceEx]]:​ [+ 2.7.1] ''​FaceStation F2''​ Gets the user information of the given user ID. 
 +  * [[BS2_GetUserDatasFaceEx]]:​ [+ 2.7.1] ''​FaceStation F2''​ Gets selected data of user.
  
  
Line 76: Line 78:
 \\ \\
 ==== BS2UserSetting ==== ==== BS2UserSetting ====
 +<WRAP tip 70%> 
 +**Tip**\\ 
 +<wrap em>Other than FaceStation F2</​wrap>​ \\ 
 +Please use [[user management api#​BS2UserSettingEx|BS2UserSettingEx]] for <wrap em>​FaceStation F2</​wrap>​. 
 +</​WRAP>​
 <code cpp> <code cpp>
 typedef struct { typedef struct {
Line 88: Line 94:
 </​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 173: Line 182:
 Personal Identification Number(PIN). It should be entered through //​BS_MakePinCode//​ function. \\ \\  Personal Identification Number(PIN). It should be entered through //​BS_MakePinCode//​ function. \\ \\ 
 **6. //​cardObjs//​** \\  **6. //​cardObjs//​** \\ 
-Card list for user authentication that needs to exist as much as **user.numCards**. Refer to [[Smartcard API]] for data format. \\ \\ +Card list for user authentication that needs to exist as much as **user.numCards**. Refer to [[Smartcard API]] for data format. \\ In case of Secure Crendential card, cardObjs array of BS2UserBlob structure should be filled and the user should be updated after Secure Crendential card issuing. \\ \\
 **7. //​fingerObjs//​** \\  **7. //​fingerObjs//​** \\ 
 Fingerprint template for user authentication that needs to exist as much as **user.numFingers**. Refer to [[Fingerprint API]] for data format. \\ \\ Fingerprint template for user authentication that needs to exist as much as **user.numFingers**. Refer to [[Fingerprint API]] for data format. \\ \\
Line 238: Line 247:
 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. ​(FaceStation 2 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 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 293: Line 308:
     uint32_t accessGroupId[BS2_MAX_NUM_OF_ACCESS_GROUP_PER_USER];​     uint32_t accessGroupId[BS2_MAX_NUM_OF_ACCESS_GROUP_PER_USER];​
 } BS2UserSmallBlobEx;​ } BS2UserSmallBlobEx;​
 +</​code>​
 +**1. //user//** \\ 
 +Structure that defines the basic user information.\\ \\ 
 +**2. //​setting//​** \\ 
 +Structure that defines the configuration value for user identification. \\ \\ 
 +**3. //name//** \\ 
 +User name having UTF-8 for string encoding. \\ \\
 +**4. //photo//** \\ 
 +User profile image, which supports only Jpeg images. \\ \\ 
 +**5. //pin//** \\ 
 +Personal Identification Number(PIN). It should be entered through //​BS_MakePinCode//​ function. \\ \\ 
 +**6. //​cardObjs//​** \\ 
 +Card list for user authentication that needs to exist as much as **user.numCards**. Refer to [[Smartcard API]] for data format. \\ \\ 
 +**7. //​fingerObjs//​** \\ 
 +Fingerprint template for user authentication that needs to exist as much as **user.numFingers**. Refer to [[Fingerprint API]] for data format. \\ \\
 +**8. //​faceObjs//​** \\ 
 +Face template for user authentication that needs to exist as much as **user.numFaces**. Refer to [[Face API]] for data format. \\ \\
 +**9. //job//** \\ 
 +Job code that will be allocated to user. \\ \\
 +**10. //​phrase//​** \\ 
 +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//​** \\ 
 +List of access groups where users belong to which can be configured up to 16 groups.\\ \\ 
 +
 +
 +
 +==== BS2UserSettingEx ====
 +<WRAP tip 70%>
 +**Tip**\\
 +<wrap em>​FaceStation F2 Only</​wrap> ​ \\
 +Please use [[user management api#​BS2UserSetting|BS2UserSetting]] <wrap em>other than</​wrap>​ FaceStation F2.
 +</​WRAP>​
 +<code cpp>
 +typedef struct {
 +    uint8_t faceAuthMode;​
 +    uint8_t fingerprintAuthMode;​
 +    uint8_t cardAuthMode;​
 +    uint8_t idAuthMode;
 +    uint8_t reserved[28];​
 +} BS2UserSettingEx;​
 +</​code>​
 +1. //​faceAuthMode//​ \\ 
 +User facial authentication mode \\
 +<WRAP group 60%>
 +^Value ​ ^Level 1 ^Level 2  ^Level 3  ^Level 4  ^
 +|11 |Face |      |  |
 +|12 |Face  |Fingerprint ​ |  |
 +|13 |Face  |PIN   ​| ​ |
 +|14 |Face  |Fingerprint or PIN  |  |
 +|15 |Face  |Fingerprint ​ |PIN  |
 +|254 |Cannot use  |  |  |
 +|255 |Not defined(System defined mode)  |  |  |
 +</​WRAP>​
 +2. //​fingerprintAuthMode//​ \\ 
 +User fingerprint authentication mode \\ 
 +<WRAP group 60%>
 +^Value ​ ^Level 1  ^Level 2  ^Level 3  ^Level 4  ^
 +|16 |Fingerprint ​ |      |  |
 +|17 |Fingerprint ​ |Face  |  |
 +|18 |Fingerprint ​ |PIN   ​| ​ |
 +|19 |Fingerprint ​ |Face or PIN  |  |
 +|20 |Fingerprint ​ |Face  |PIN  |
 +|254 |Cannot use  |  |  |
 +|255 |Not defined(System defined mode)  |  |  |
 +</​WRAP>​
 +3. //​cardAuthMode//​ \\ 
 +User card authentication mode  \\ 
 +<WRAP group 60%>
 +^Value ​ ^Level 1  ^Level 2  ^Level 3  ^Level 4  ^
 +|21  |Card  |      |   |
 +|22  |Card  |Face  |   |
 +|23  |Card  |Fingerprint ​ |   |
 +|24  |Card  |PIN  |   |
 +|25  |Card  |Face or Fingerprint ​ |   |
 +|26  |Card  |Face or PIN  |   |
 +|27  |Card  |Fingerprint or PIN  |   |
 +|28  |Card  |Face or Fingerprint or PIN  |   |
 +|29  |Card  |Face  |Fingerprint ​ |
 +|30  |Card  |Face  |PIN  |
 +|31  |Card  |Fingerprint ​ |Face  |
 +|32  |Card  |Fingerprint ​ |PIN  |
 +|33  |Card  |Face or Fingerprint ​ |PIN  |
 +|34  |Card  |Face  |Fingerprint or PIN  |
 +|35  |Card  |Fingerprint ​ |Face or PIN  |
 +|254 |Cannot use  |  |  |
 +|255 |Not defined(System defined mode)  |  |  |
 +</​WRAP>​
 +4. //​idAuthMode//​ \\ 
 +User ID authentication mode \\ 
 +<WRAP group 60%>
 +^Value ​ ^Level 1  ^Level 2  ^Level 3  ^Level 4  ^
 +|36  |ID  |Face  |   |
 +|37  |ID  |Fingerprint ​ |   |
 +|38  |ID  |PIN  |   |
 +|39  |ID  |Face or Fingerprint ​ |   |
 +|40  |ID  |Face or PIN  |   |
 +|41  |ID  |Fingerprint or PIN  |   |
 +|42  |ID  |Face or Fingerprint or PIN  |   |
 +|43  |ID  |Face  |Fingerprint ​ |
 +|44  |ID  |Face  |PIN  |
 +|45  |ID  |Fingerprint ​ |Face  |
 +|46  |ID  |Fingerprint ​ |PIN  |
 +|47  |ID  |Face or Fingerprint ​ |PIN  |
 +|48  |ID  |Face  |Fingerprint or PIN  |
 +|49  |ID  |Fingerprint ​ |Face or PIN  |
 +|254 |Cannot use  |  |  |
 +|255 |Not defined(System defined mode)  |  |  |
 +</​WRAP>​
 +5. //​reserved//​ \\ 
 +Reserved \\ \\ 
 +
 +==== BS2UserFaceExBlob ====
 +<code cpp>
 +typedef struct
 +{
 +    BS2User user;
 +    BS2UserSetting setting;
 +    BS2_USER_NAME user_name;
 +    BS2UserPhoto* user_photo_obj;​
 +    BS2_USER_PIN pin;
 +    BS2CSNCard* cardObjs;
 +    BS2Fingerprint* fingerObjs;
 +    BS2Face* faceObjs; ​                 // FS2, FL
 +    BS2Job job;
 +    BS2_USER_PHRASE phrase;
 +    BS2_ACCESS_GROUP_ID accessGroupId[BS2_MAX_NUM_OF_ACCESS_GROUP_PER_USER];​
 +
 +    BS2UserSettingEx settingEx; ​        // F2
 +    BS2FaceEx* faceExObjs; ​             // F2
 +} BS2UserFaceExBlob;​
 </​code>​ </​code>​
 1. //user// \\  1. //user// \\ 
-사용자의 기본 정보를 정의한 구조체입니다. ​\\ \\ +Basic user information defined structure ​\\ \\ 
 2. //setting// \\  2. //setting// \\ 
-사용자 식별을 위한 설정값을 정의한 구조체입니다. ​\\ \\ +Basic user setting defined structure ​\\ \\ 
 3. //name// \\  3. //name// \\ 
-사용자 이름이며 문자열 인코딩은 ​UTF-8입니다. ​\\ \\ +User name (Encoding : UTF-8) \\ \\ 
 4. //photo// \\  4. //photo// \\ 
-사용자 프로파일 이미지이며 Jpeg 이미지만 지원합니다. ​\\ \\ +User profile image (Only support jpeg) \\ \\
 5. //pin// \\  5. //pin// \\ 
-PIN 값이며 반드시 ​//BS_MakePinCode// 함수를 통해 암호화된 문자열을 입력해야 합니다. \\ \\ +PIN, must be filled with a return of API //BS2_MakePinCode// 
 6. //​cardObjs//​ \\  6. //​cardObjs//​ \\ 
-사용자 인증을 위한 카드 리스트로 반드시 ​**user.numCards**만큼 존재해야 합니다. 데이터 형식은 ​[[Smartcard API]]를 참고하십시오. \\ \\ +Card list for user authentication,​ there must be as many as **user.numCards**. ​Refer to [[Smartcard API]] for data format. \\ \\ 
 7. //​fingerObjs//​ \\  7. //​fingerObjs//​ \\ 
-사용자 인증을 위한 지문 템플릿 리스트로 반드시 ​**user.numFingers**만큼 존재해야 합니다. 데이터 형식은 ​[[Fingerprint API]]를 참고하십시오. \\ \\ +Fingerprint template list for user authentication,​ there must be as many as **user.numFingers**. ​Refer to [[Fingerprint API]] for data format. \\ \\ 
 8. //​faceObjs//​ \\  8. //​faceObjs//​ \\ 
-사용자 인증을 위한 얼굴 템플릿 리스트로 반드시 ​**user.numFaces**만큼 존재해야 합니다. 데이터 형식은 ​[[Face API]]를 참고하십시오. \\ \\ +''​FaceStation2'',​ ''​FaceLite''​ Face template list for user authentication,​ there must be as many as **user.numFaces**. ​Refer to [[Face API]] for data format. \\ \\ 
 9. //job// \\  9. //job// \\ 
-근태모드에서 사용자의 작업코드입니다. ​\\ \\ +Job code in T&A mode \\ \\ 
 10. //phrase// \\  10. //phrase// \\ 
-인증시 장치 UI에서 표시되는 개인 메시지입니다. (FaceStation2 만 지원) \\ \\ +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//​ \\ 
-사용자가 속한 출입 그룹을 나열한 리스트로 최대 ​16개까지 설정할 수 있습니다. \\ \\ +List of access group of the user assigned, maximum is 16. \\ \\  
 +12. //​settingEx//​ \\  
 +''​FaceStation F2''​ Sets private authentication. It is now possible to combine more various authentication modes by combining fingerprints and faces. \\ \\  
 +13. //​faceExObjs//​ \\  
 +''​FaceStation F2''​ Face template list for user authentication,​ there must be as many as **user.numFaces**. Refer to [[Face API]] for data format. \\ \\