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/11/26 17:34] kkshin [BS2UserSetting] |
en:user_management_api [2022/09/15 08:13] mark |
||
|---|---|---|---|
| Line 78: | Line 78: | ||
| \\ | \\ | ||
| ==== BS2UserSetting ==== | ==== BS2UserSetting ==== | ||
| - | ''Other than FaceStation F2'' \\ | + | <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 90: | 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 240: | 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. (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 316: | Line 328: | ||
| 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 323: | Line 341: | ||
| ==== BS2UserSettingEx ==== | ==== BS2UserSettingEx ==== | ||
| - | ''FaceStation F2 Only'' \\ | + | <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> | <code cpp> | ||
| typedef struct { | typedef struct { | ||
| Line 442: | 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 450: | 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. \\ \\ | ||