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 [2019/03/04 13:20] yjjung [User Management API] |
en:user_management_api [2019/05/27 16:07] yjjung |
||
|---|---|---|---|
| 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_EnrolUserEx]]: [+ 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) | ||
| + | * [[BS2_GetSupportedUserMask]]: Gets user settings supported by the device. | ||
| + | * [[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_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 208: | Line 217: | ||
| BS2_USER_PHRASE phrase; | BS2_USER_PHRASE phrase; | ||
| uint32_t accessGroupId[BS2_MAX_NUM_OF_ACCESS_GROUP_PER_USER]; | uint32_t accessGroupId[BS2_MAX_NUM_OF_ACCESS_GROUP_PER_USER]; | ||
| - | } BS2UserBlob; | + | } BS2UserBlobEx; |
| </code> | </code> | ||
| **1. //user//** \\ | **1. //user//** \\ | ||
| Line 232: | Line 241: | ||
| **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.\\ \\ | ||
| + | |||
| + | |||
| + | |||
| + | ==== 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// \\ | ||
| + | 사용자의 기본 정보를 정의한 구조체입니다. \\ \\ | ||
| + | 2. //setting// \\ | ||
| + | 사용자 식별을 위한 설정값을 정의한 구조체입니다. \\ \\ | ||
| + | 3. //name// \\ | ||
| + | 사용자 이름이며 문자열 인코딩은 UTF-8입니다. \\ \\ | ||
| + | 4. //photo// \\ | ||
| + | 사용자 프로파일 이미지이며 Jpeg 이미지만 지원합니다. \\ \\ | ||
| + | 5. //pin// \\ | ||
| + | PIN 값이며 반드시 //BS_MakePinCode// 함수를 통해 암호화된 문자열을 입력해야 합니다. \\ \\ | ||
| + | 6. //cardObjs// \\ | ||
| + | 사용자 인증을 위한 카드 리스트로 반드시 **user.numCards**만큼 존재해야 합니다. 데이터 형식은 [[Smartcard API]]를 참고하십시오. \\ \\ | ||
| + | 7. //fingerObjs// \\ | ||
| + | 사용자 인증을 위한 지문 템플릿 리스트로 반드시 **user.numFingers**만큼 존재해야 합니다. 데이터 형식은 [[Fingerprint API]]를 참고하십시오. \\ \\ | ||
| + | 8. //faceObjs// \\ | ||
| + | 사용자 인증을 위한 얼굴 템플릿 리스트로 반드시 **user.numFaces**만큼 존재해야 합니다. 데이터 형식은 [[Face API]]를 참고하십시오. \\ \\ | ||
| + | 9. //accessGroupId// \\ | ||
| + | 사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | ||
| + | |||
| + | |||
| + | ==== 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// \\ | ||
| + | 사용자의 기본 정보를 정의한 구조체입니다. \\ \\ | ||
| + | 2. //setting// \\ | ||
| + | 사용자 식별을 위한 설정값을 정의한 구조체입니다. \\ \\ | ||
| + | 3. //name// \\ | ||
| + | 사용자 이름이며 문자열 인코딩은 UTF-8입니다. \\ \\ | ||
| + | 4. //photo// \\ | ||
| + | 사용자 프로파일 이미지이며 Jpeg 이미지만 지원합니다. \\ \\ | ||
| + | 5. //pin// \\ | ||
| + | PIN 값이며 반드시 //BS_MakePinCode// 함수를 통해 암호화된 문자열을 입력해야 합니다. \\ \\ | ||
| + | 6. //cardObjs// \\ | ||
| + | 사용자 인증을 위한 카드 리스트로 반드시 **user.numCards**만큼 존재해야 합니다. 데이터 형식은 [[Smartcard API]]를 참고하십시오. \\ \\ | ||
| + | 7. //fingerObjs// \\ | ||
| + | 사용자 인증을 위한 지문 템플릿 리스트로 반드시 **user.numFingers**만큼 존재해야 합니다. 데이터 형식은 [[Fingerprint API]]를 참고하십시오. \\ \\ | ||
| + | 8. //faceObjs// \\ | ||
| + | 사용자 인증을 위한 얼굴 템플릿 리스트로 반드시 **user.numFaces**만큼 존재해야 합니다. 데이터 형식은 [[Face API]]를 참고하십시오. \\ \\ | ||
| + | 9. //job// \\ | ||
| + | 근태모드에서 사용자의 작업코드입니다. \\ \\ | ||
| + | 10. //phrase// \\ | ||
| + | 인증시 장치 UI에서 표시되는 개인 메시지입니다. (FaceStation2 만 지원) \\ \\ | ||
| + | 11. //accessGroupId// \\ | ||
| + | 사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | ||
| + | |||