차이
문서의 선택한 두 판 사이의 차이를 보여줍니다.
양쪽 이전 판 이전 판 다음 판 | 이전 판 다음 판 양쪽 다음 판 | ||
ko:user_management_api [2019/05/14 11:55] kkshin |
ko:user_management_api [2021/01/18 11:30] kkshin |
||
---|---|---|---|
줄 8: | 줄 8: | ||
* [[BS2_RemoveAllUser]]: 모든 사용자를 삭제합니다. | * [[BS2_RemoveAllUser]]: 모든 사용자를 삭제합니다. | ||
* [[BS2_GetUserInfos]]: 주어진 사용자 ID의 정보를 가져옵니다. | * [[BS2_GetUserInfos]]: 주어진 사용자 ID의 정보를 가져옵니다. | ||
- | * [[BS2_GetUserInfosEx]]: 주어진 사용자 ID의 정보를 가져옵니다. ([+ 2.4.0] Job code, User phrase 포함) | + | * [[BS2_GetUserInfosEx]]: [+ 2.4.0] 주어진 사용자 ID의 정보를 가져옵니다. (Job code, User phrase 포함) |
- | * <del>[[BS2_EnrolUser]]: 새로운 사용자를 등록합니다.</del> --- Deprecated | + | * [[BS2_EnrolUser]]: 새로운 사용자를 등록합니다. |
- | * <del>[[BS2_EnrolUserEx]]: 새로운 사용자를 등록합니다.([+ 2.4.0] Job code, User phrase 포함)</del> --- 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 포함) | ||
* [[BS2_GetUserDatas]]: 사용자 정보의 일부를 선별적으로 가져옵니다. | * [[BS2_GetUserDatas]]: 사용자 정보의 일부를 선별적으로 가져옵니다. | ||
- | * [[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_EnrollUserSmall]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 새로운 사용자를 등록합니다. | ||
* [[BS2_EnrollUserSmallEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 새로운 사용자를 등록합니다. | * [[BS2_EnrollUserSmallEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 새로운 사용자를 등록합니다. | ||
+ | * [[BS2_GetUserSmallInfos]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 주어진 사용자 ID의 정보를 가져옵니다. | ||
* [[BS2_GetUserSmallInfosEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 주어진 사용자 ID의 정보를 가져옵니다. | * [[BS2_GetUserSmallInfosEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 주어진 사용자 ID의 정보를 가져옵니다. | ||
+ | * [[BS2_GetUserSmallDatas]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 사용자 정보의 일부를 선별적으로 가져옵니다. | ||
* [[BS2_GetUserSmallDatasEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 사용자 정보의 일부를 선별적으로 가져옵니다. | * [[BS2_GetUserSmallDatasEx]]: [+ 2.6.3] 효율적으로 메모리를 사용하여, 사용자 정보의 일부를 선별적으로 가져옵니다. | ||
+ | * [[BS2_EnrollUserFaceEx]]: [+ 2.7.1] ''FaceStation F2''새로운 사용자를 등록합니다. | ||
+ | * [[BS2_GetUserInfosFaceEx]]: [+ 2.7.1] ''FaceStation F2''주어진 사용자 ID의 정보를 가져옵니다. | ||
+ | * [[BS2_GetUserDatasFaceEx]]: [+ 2.7.1] ''FaceStation F2''사용자 정보의 일부를 선별적으로 가져옵니다. | ||
===== 구조체 ===== | ===== 구조체 ===== | ||
줄 68: | 줄 73: | ||
\\ | \\ | ||
==== BS2UserSetting ==== | ==== BS2UserSetting ==== | ||
+ | <WRAP tip 70%> | ||
+ | **도움말**\\ | ||
+ | <wrap em>FaceStation F2 이외</wrap> \\ | ||
+ | <wrap em>FaceStation F2</wrap>는 [[user management api#BS2UserSettingEx|BS2UserSettingEx]]를 사용해 주십시오. | ||
+ | </WRAP> | ||
<code cpp> | <code cpp> | ||
typedef struct { | typedef struct { | ||
줄 228: | 줄 237: | ||
근태모드에서 사용자의 작업코드입니다. \\ \\ | 근태모드에서 사용자의 작업코드입니다. \\ \\ | ||
10. //phrase// \\ | 10. //phrase// \\ | ||
- | 인증시 장치 UI에서 표시되는 개인 메시지입니다. (FaceStation2 만 지원) \\ \\ | + | 인증시 장치 UI에서 표시되는 개인 메시지입니다. (FS2 FW 1.0.0 이상에서만 가능) \\ |
11. //accessGroupId// \\ | 11. //accessGroupId// \\ | ||
사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | 사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | ||
줄 301: | 줄 310: | ||
근태모드에서 사용자의 작업코드입니다. \\ \\ | 근태모드에서 사용자의 작업코드입니다. \\ \\ | ||
10. //phrase// \\ | 10. //phrase// \\ | ||
- | 인증시 장치 UI에서 표시되는 개인 메시지입니다. (FaceStation2 만 지원) \\ \\ | + | 인증시 장치 UI에서 표시되는 개인 메시지입니다. (FS2 FW 1.0.0 이상 버전에서만 가능)\\ \\ |
11. //accessGroupId// \\ | 11. //accessGroupId// \\ | ||
사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | 사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | ||
+ | |||
+ | |||
+ | ==== BS2UserSettingEx ==== | ||
+ | <WRAP tip 70%> | ||
+ | **도움말**\\ | ||
+ | <wrap em>FaceStation F2 만</wrap> \\ | ||
+ | FaceStation F2 <wrap em>이외의 장치</wrap>는 [[user management api#BS2UserSetting|BS2UserSetting]]를 사용해 주십시오. | ||
+ | </WRAP> | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t faceAuthMode; | ||
+ | uint8_t fingerprintAuthMode; | ||
+ | uint8_t cardAuthMode; | ||
+ | uint8_t idAuthMode; | ||
+ | uint8_t reserved[28]; | ||
+ | } BS2UserSettingEx; | ||
+ | </code> | ||
+ | ''FaceStation F2'' \\ \\ | ||
+ | 1. //faceAuthMode// \\ | ||
+ | 사용자 인증을 위한 얼굴 인증 설정 모드입니다. \\ | ||
+ | <WRAP group 60%> | ||
+ | ^값 ^1단계 인증 ^2단계 인증 ^3단계 인증 ^4단계 인증 ^ | ||
+ | |11 |얼굴 | | | | ||
+ | |12 |얼굴 |지문 | | | ||
+ | |13 |얼굴 |PIN | | | ||
+ | |14 |얼굴 |지문 또는 PIN | | | ||
+ | |15 |얼굴 |지문 |PIN | | ||
+ | |254 |사용할 수 없음 | | | | ||
+ | |255 |정의되지 않음(시스템 정의 모드) | | | | ||
+ | </WRAP> | ||
+ | 2. //fingerprintAuthMode// \\ | ||
+ | 사용자 인증을 위한 지문 인증 설정 모드입니다. \\ | ||
+ | <WRAP group 60%> | ||
+ | ^값 ^1단계 인증 ^2단계 인증 ^3단계 인증 ^4단계 인증 ^ | ||
+ | |16 |지문 | | | | ||
+ | |17 |지문 |얼굴 | | | ||
+ | |18 |지문 |PIN | | | ||
+ | |19 |지문 |얼굴 또는 PIN | | | ||
+ | |20 |지문 |얼굴 |PIN | | ||
+ | |254 |사용할 수 없음 | | | | ||
+ | |255 |정의되지 않음(시스템 정의 모드) | | | | ||
+ | </WRAP> | ||
+ | 3. //cardAuthMode// \\ | ||
+ | 사용자 인증을 위한 카드 인증 설정 모드입니다. \\ | ||
+ | <WRAP group 60%> | ||
+ | ^값 ^1단계 인증 ^2단계 인증 ^3단계 인증 ^ | ||
+ | |21 |카드 | | | | ||
+ | |22 |카드 |얼굴 | | | ||
+ | |23 |카드 |지문 | | | ||
+ | |24 |카드 |PIN | | | ||
+ | |25 |카드 |얼굴 또는 지문 | | | ||
+ | |26 |카드 |얼굴 또는 PIN | | | ||
+ | |27 |카드 |지문 또는 PIN | | | ||
+ | |28 |카드 |얼굴 또는 지문 또는 PIN | | | ||
+ | |29 |카드 |얼굴 |지문 | | ||
+ | |30 |카드 |얼굴 |PIN | | ||
+ | |31 |카드 |지문 |얼굴 | | ||
+ | |32 |카드 |지문 |PIN | | ||
+ | |33 |카드 |얼굴 또는 지문 |PIN | | ||
+ | |34 |카드 |얼굴 |지문 또는 PIN | | ||
+ | |35 |카드 |지문 |얼굴 또는 PIN | | ||
+ | |254 |사용할 수 없음 | | | | ||
+ | |255 |정의되지 않음(시스템 정의 모드) | | | | ||
+ | </WRAP> | ||
+ | 4. //idAuthMode// \\ | ||
+ | 사용자 인증을 위한 ID 인증 설정 모드입니다. \\ | ||
+ | <WRAP group 60%> | ||
+ | ^값 ^1단계 인증 ^2단계 인증 ^3단계 인증 ^ | ||
+ | |36 |ID |얼굴 | | | ||
+ | |37 |ID |지문 | | | ||
+ | |38 |ID |PIN | | | ||
+ | |39 |ID |얼굴 또는 지문 | | | ||
+ | |40 |ID |얼굴 또는 PIN | | | ||
+ | |41 |ID |지문 또는 PIN | | | ||
+ | |42 |ID |얼굴 또는 지문 또는 PIN | | | ||
+ | |43 |ID |얼굴 |지문 | | ||
+ | |44 |ID |얼굴 |PIN | | ||
+ | |45 |ID |지문 |얼굴 | | ||
+ | |46 |ID |지문 |PIN | | ||
+ | |47 |ID |얼굴 또는 지문 |PIN | | ||
+ | |48 |ID |얼굴 |지문 또는 PIN | | ||
+ | |49 |ID |지문 |얼굴 또는 PIN | | ||
+ | |254 |사용할 수 없음 | | | | ||
+ | |255 |정의되지 않음(시스템 정의 모드) | | | | ||
+ | </WRAP> | ||
+ | 5. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | |||
+ | |||
+ | ==== BS2UserFaceExBlob ==== | ||
+ | <code cpp> | ||
+ | typedef struct | ||
+ | { | ||
+ | BS2User user; | ||
+ | BS2UserSetting setting; | ||
+ | BS2_USER_NAME user_name; | ||
+ | BS2UserPhoto* user_photo_obj; | ||
+ | BS2_USER_PIN pin; | ||
+ | BS2CSNCard* cardObjs; | ||
+ | BS2Fingerprint* fingerObjs; | ||
+ | BS2Face* faceObjs; // FS2, FL | ||
+ | BS2Job job; | ||
+ | BS2_USER_PHRASE phrase; | ||
+ | BS2_ACCESS_GROUP_ID accessGroupId[BS2_MAX_NUM_OF_ACCESS_GROUP_PER_USER]; | ||
+ | |||
+ | BS2UserSettingEx settingEx; // F2 | ||
+ | BS2FaceEx* faceExObjs; // F2 | ||
+ | } BS2UserFaceExBlob; | ||
+ | </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// \\ | ||
+ | ''FaceLite'' 사용자 인증을 위한 얼굴 템플릿 리스트로 반드시 **user.numFaces**만큼 존재해야 합니다. 데이터 형식은 [[Face API]]를 참고하십시오. \\ \\ | ||
+ | 9. //job// \\ | ||
+ | 근태모드에서 사용자의 작업코드입니다. \\ \\ | ||
+ | 10. //phrase// \\ | ||
+ | 인증시 장치 UI에서 표시되는 개인 메시지입니다. (FS2 FW 1.0.0 이상 버전에서만 가능)\\ \\ | ||
+ | 11. //accessGroupId// \\ | ||
+ | 사용자가 속한 출입 그룹을 나열한 리스트로 최대 16개까지 설정할 수 있습니다. \\ \\ | ||
+ | 12. //settingEx// \\ | ||
+ | ''FaceStation F2'' 개인인증모드를 설정할 수 있습니다. 지문과 얼굴을 함께 조합한 더 다양한 인증모드의 조합이 가능하게 되었습니다. \\ \\ | ||
+ | 13. //faceExObjs// \\ | ||
+ | ''FaceStation F2'' 사용자 인증을 위한 얼굴 템플릿 리스트로 반드시 **user.numFaces**만큼 존재해야 합니다. 데이터 형식은 [[Face API]]를 참고하십시오. \\ \\ | ||
+ |