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/09/10 12:56] yjjung |
en:user_management_api [2021/06/07 13:30] kkshin |
||
|---|---|---|---|
| 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. | ||
| 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. [+ V2.7.1] | + | * [[BS2_EnrollUserFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Enrolls new user. |
| - | * [[BS2_GetUserInfosFaceEx]]: ''FaceStation F2'' Gets the user information of the given user ID. [+ V2.7.1] | + | * [[BS2_GetUserInfosFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Gets the user information of the given user ID. |
| - | * [[BS2_GetUserDatasFaceEx]]: ''FaceStation F2'' Gets selected data of user. [+ V2.7.1] | + | * [[BS2_GetUserDatasFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Gets selected data of user. |
| Line 78: | 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 240: | Line 244: | ||
| 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 325: | ||
| 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 338: | ||
| ==== BS2UserSettingEx ==== | ==== 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> | <code cpp> | ||
| typedef struct { | typedef struct { | ||
| Line 332: | Line 352: | ||
| } BS2UserSettingEx; | } BS2UserSettingEx; | ||
| </code> | </code> | ||
| - | ''FaceStation F2'' \\ \\ | ||
| 1. //faceAuthMode// \\ | 1. //faceAuthMode// \\ | ||
| User facial authentication mode \\ | User facial authentication mode \\ | ||
| Line 442: | Line 461: | ||
| 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. \\ \\ | ||