차이
문서의 선택한 두 판 사이의 차이를 보여줍니다.
| 양쪽 이전 판 이전 판 다음 판 | 이전 판 다음 판 양쪽 다음 판 | ||
|
ko:user_management_api [2019/05/14 10:00] kkshin |
ko:user_management_api [2020/02/12 14:35] sypark1 |
||
|---|---|---|---|
| 줄 9: | 줄 9: | ||
| * [[BS2_GetUserInfos]]: 주어진 사용자 ID의 정보를 가져옵니다. | * [[BS2_GetUserInfos]]: 주어진 사용자 ID의 정보를 가져옵니다. | ||
| * [[BS2_GetUserInfosEx]]: 주어진 사용자 ID의 정보를 가져옵니다. ([+ 2.4.0] Job code, User phrase 포함) | * [[BS2_GetUserInfosEx]]: 주어진 사용자 ID의 정보를 가져옵니다. ([+ 2.4.0] Job code, User phrase 포함) | ||
| - | * <del>[[BS2_EnrolUser]]</del>: 새로운 사용자를 등록합니다. - Deprecated | + | * [[BS2_EnrolUser]]: 새로운 사용자를 등록합니다. |
| - | * <del>[[BS2_EnrolUserEx]]</del>: 새로운 사용자를 등록합니다.([+ 2.4.0] Job code, User phrase 포함) - Deprecated | + | * [[BS2_EnrolUserEx]]: 새로운 사용자를 등록합니다.([+ 2.4.0] Job code, User phrase 포함) |
| * [[BS2_EnrollUser]]: [+ 2.6.3] 새로운 사용자를 등록합니다. | * [[BS2_EnrollUser]]: [+ 2.6.3] 새로운 사용자를 등록합니다. | ||
| * [[BS2_EnrollUserEx]]: [+ 2.6.3] 새로운 사용자를 등록합니다.(Job code, User phrase 포함) | * [[BS2_EnrollUserEx]]: [+ 2.6.3] 새로운 사용자를 등록합니다.(Job code, User phrase 포함) | ||
| 줄 16: | 줄 16: | ||
| * [[BS2_GetUserDatasEx]]: 사용자 정보의 일부를 선별적으로 가져옵니다.([+ 2.5.0] Job code, User phrase 포함) | * [[BS2_GetUserDatasEx]]: 사용자 정보의 일부를 선별적으로 가져옵니다.([+ 2.5.0] Job code, User phrase 포함) | ||
| * [[BS2_GetSupportedUserMask]]: 장치에서 지원하는 사용자 설정을 가져옵니다. | * [[BS2_GetSupportedUserMask]]: 장치에서 지원하는 사용자 설정을 가져옵니다. | ||
| + | * [[BS2_EnrollUserSmall]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 새로운 사용자를 등록합니다. | ||
| + | * [[BS2_EnrollUserSmallEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 새로운 사용자를 등록합니다. | ||
| + | * [[BS2_GetUserSmallInfos]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 주어진 사용자 ID의 정보를 가져옵니다. | ||
| + | * [[BS2_GetUserSmallInfosEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 주어진 사용자 ID의 정보를 가져옵니다. | ||
| + | * [[BS2_GetUserSmallDatas]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 사용자 정보의 일부를 선별적으로 가져옵니다. | ||
| + | * [[BS2_GetUserSmallDatasEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 사용자 정보의 일부를 선별적으로 가져옵니다. | ||
| ===== 구조체 ===== | ===== 구조체 ===== | ||
| 줄 204: | 줄 209: | ||
| 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> | ||
| + | 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에서 표시되는 개인 메시지입니다. (FS2 FW 1.0.0 이상에서만 가능) \\ | ||
| + | 11. //accessGroupId// \\ | ||
| + | 사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | ||
| + | |||
| + | ==== 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> | </code> | ||
| 1. //user// \\ | 1. //user// \\ | ||
| 줄 225: | 줄 303: | ||
| 근태모드에서 사용자의 작업코드입니다. \\ \\ | 근태모드에서 사용자의 작업코드입니다. \\ \\ | ||
| 10. //phrase// \\ | 10. //phrase// \\ | ||
| - | 인증시 장치 UI에서 표시되는 개인 메시지입니다. (FaceStation2 만 지원) \\ \\ | + | 인증시 장치 UI에서 표시되는 개인 메시지입니다. (FS2 FW 1.0.0 이상 버전에서만 가능)\\ \\ |
| 11. //accessGroupId// \\ | 11. //accessGroupId// \\ | ||
| 사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | 사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | ||