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 [2021/05/27 14:24] kkshin [BS2UserBlobEx] |
en:user_management_api [2022/09/15 08:13] mark |
||
---|---|---|---|
Line 94: | 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 246: | Line 249: | ||
Private message that will be displayed when the user authenticates. \\ | Private message that will be displayed when the user authenticates. \\ | ||
<WRAP group 30%> | <WRAP group 30%> | ||
- | ^Device ^Supported Ver. ^ | + | ^Model ^Supported Ver. ^ |
|FaceStation 2 |V1.0.0 or higher | | |FaceStation 2 |V1.0.0 or higher | | ||
|FaceStation F2 |V1.0.0 or higher | | |FaceStation F2 |V1.0.0 or higher | | ||
+ | |X-Station 2 |V1.0.0 or higher | | ||
</WRAP> | </WRAP> | ||
**11. //accessGroupId//** \\ | **11. //accessGroupId//** \\ | ||
Line 326: | Line 330: | ||
Private message that will be displayed when the user authenticates. \\ | Private message that will be displayed when the user authenticates. \\ | ||
<WRAP group 30%> | <WRAP group 30%> | ||
- | ^Device ^Supported Ver. ^ | + | ^Model ^Supported Ver. ^ |
|FaceStation 2 |V1.0.0 or higher | | |FaceStation 2 |V1.0.0 or higher | | ||
|FaceStation F2 |V1.0.0 or higher | | |FaceStation F2 |V1.0.0 or higher | | ||
+ | |X-Station 2 |V1.0.0 or higher | | ||
</WRAP> | </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 460: | Line 464: | ||
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 468: | Line 478: | ||
''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. \\ \\ |