Differences

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

--- en:user_management_api [2019/05/27 16:07]
yjjung [BS2UserBlobEx]
+++ en:user_management_api [2020/02/12 14:54]
sypark1
@@ Line 19: / Line 19: @@
   * [[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_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_GetUserSmallDatasEx]]: [+ 2.6.3] Gets selected data of user with efficient use of memory.
@@ Line 173: / Line 173: @@
 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. \\ \\
+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//** \\
 Fingerprint template for user authentication that needs to exist as much as **user.numFingers**. Refer to [[Fingerprint API]] for data format. \\ \\
@@ Line 238: / Line 238: @@
 Job code that will be allocated to user. \\ \\
 **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. (only in FS2 FW 1.0.0 or higher) \\ \\
 **11. //accessGroupId//** \\
 List of access groups where users belong to which can be configured up to 16 groups.\\ \\
+==== BS2UserSmallBlob ====
+<code cpp>
+typedef struct {
+    BS2User user;
+    BS2UserSetting setting;
+    uint8_t name[BS2_USER_NAME_SIZE];
+    BS2UserPhoto* photo;
+    uint8_t pin[BS2_PIN_HASH_SIZE];
+    BS2CSNCard* cardObjs;
+    BS2Fingerprint* fingerObjs;
+    BS2Face* faceObjs;
+    uint32_t accessGroupId[BS2_MAX_NUM_OF_ACCESS_GROUP_PER_USER];
+} BS2UserSmallBlob;
+</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. //accessGroupId//** \\
+List of access groups where users belong to which can be configured up to 16 groups.\\ \\
+==== BS2UserSmallBlobEx ====
+<code cpp>
+typedef struct {
+    BS2User user;
+    BS2UserSetting setting;
+    uint8_t name[BS2_USER_NAME_SIZE];
+    BS2UserPhoto* photo;
+    uint8_t pin[BS2_PIN_HASH_SIZE];
+    BS2CSNCard* cardObjs;
+    BS2Fingerprint* fingerObjs;
+    BS2Face* faceObjs;
+    BS2Job job;
+    BS2_USER_PHRASE phrase;
+    uint32_t accessGroupId[BS2_MAX_NUM_OF_ACCESS_GROUP_PER_USER];
+} 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. (only in FS2 FW 1.0.0 or higher)  \\ \\
+**11. //accessGroupId//** \\
+List of access groups where users belong to which can be configured up to 16 groups.\\ \\