Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
en:user_management_api [2020/02/12 14:54] sypark1 |
en:user_management_api [2020/10/22 11:04] kkshin |
||
---|---|---|---|
Line 12: | Line 12: | ||
* [[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]]: Enrolls new user. ([+ 2.4.0] 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. (+ [2.5.0]) | ||
* [[BS2_GetUserDatasEx]]: Gets selected data of user. ([+ 2.5.0] including Job code, User phrase) | * [[BS2_GetUserDatasEx]]: Gets selected data of user. ([+ 2.5.0] including Job code, User phrase) | ||
Line 23: | Line 23: | ||
* [[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]]: ''FaceStation F2'' Enrolls new user. [+ 2.7.1] | ||
+ | * [[BS2_GetUserInfosFaceEx]]: ''FaceStation F2'' Gets the user information of the given user ID. [+ 2.7.1] | ||
+ | * [[BS2_GetUserDatasFaceEx]]: ''FaceStation F2'' Gets selected data of user. [+ 2.7.1] | ||
Line 320: | Line 322: | ||
+ | ==== BS2UserSettingEx ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t faceAuthMode; | ||
+ | uint8_t fingerprintAuthMode; | ||
+ | uint8_t cardAuthMode; | ||
+ | uint8_t idAuthMode; | ||
+ | uint8_t reserved[28]; | ||
+ | } BS2UserSettingEx; | ||
+ | </code> | ||
+ | ''FaceStation F2'' \\ \\ | ||
+ | 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> | ||
+ | 1. //user// \\ | ||
+ | Basic user information defined structure \\ \\ | ||
+ | 2. //setting// \\ | ||
+ | Basic user setting defined structure \\ \\ | ||
+ | 3. //name// \\ | ||
+ | User name (Encoding : UTF-8) \\ \\ | ||
+ | 4. //photo// \\ | ||
+ | User profile image (Only support jpeg) \\ \\ | ||
+ | 5. //pin// \\ | ||
+ | PIN, must be filled with a return of API //BS2_MakePinCode// | ||
+ | 6. //cardObjs// \\ | ||
+ | Card list for user authentication, there must be as many as **user.numCards**. Refer to [[Smartcard API]] for data format. \\ \\ | ||
+ | 7. //fingerObjs// \\ | ||
+ | Fingerprint template list for user authentication, there must be as many as **user.numFingers**. Refer to [[Fingerprint API]] for data format. \\ \\ | ||
+ | 8. //faceObjs// \\ | ||
+ | ''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// \\ | ||
+ | Job code in T&A mode \\ \\ | ||
+ | 10. //phrase// \\ | ||
+ | Personal message displayed on the device UI when authentication. (FS2 FW 1.0.0 or higher only) \\ \\ | ||
+ | 11. //accessGroupId// \\ | ||
+ | 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. \\ \\ | ||