계정 목록 조회

접근 가능한 계정 목록을 조회합니다.

HTTP 요청

GET /api/model/users
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
    https://HOSTNAME/api/model/users?offset=0&limit=20
요청 매개변수
필수타입설명비고
offsetX32비트 정수건너 뛸 갯수기본값 0
limitX32비트 정수최대 갯수기본값 2147483647
ou_guidX문자열부서 GUID 식별자
keywordsX문자열공백으로 분리된 검색어가 모두 일치하는 조건으로 검색

정상 응답

{
    "users": [
        {
            "login_name": "xeraph",
            "name": "Yang, BongYeol",
            "lang": null,
            "role": "admin",
            "menu_profile_name": "admin",
            "title": null,
            "email": null,
            "phone": null,
            "description": null,
            "enforce_password_change": false,
            "last_password_change": "2022-08-13 16:50:56+0900",
            "password_history_count": 1,
            "password_expiration_interval": 180,
            "is_enabled": true,
            "use_login_lock": false,
            "login_lock_count": 5,
            "login_failures": 0,
            "last_login_date_time": null,
            "last_login_failed_date_time": null,
            "use_idle_timeout": false,
            "idle_timeout": 300,
            "use_logout_timeout": false,
            "use_otp": false,
            "otp_seed": null,
            "use_acl": false,
            "trust_hosts": [
                "127.0.0.1"
            ],
            "grantable_menu_profiles": [
                "member",
                "custom"
            ],
            "settings": {},
            "created": "2022-08-13 16:50:56+0900",
            "updated": "2022-08-13 16:51:28+0900"
        }
    ],
    "total_count": 1
}
  • total_count (32비트 정수): 검색 조건과 일치하는 계정 수
  • users (배열): 계정 목록
    • login_name (문자열): 계정 이름
    • name (문자열): 사용자 성명
    • lang (문자열): 언어. 영어 en, 한국어 ko, 일본어 ja, 중국어 zh
    • role (문자열): 역할 이름
    • menu_profile_name (문자열): 메뉴 프로파일 이름
    • title (문자열): 직위
    • email (문자열): 이메일 주소
    • phone (문자열): 전화번호
    • description (문자열): 설명
    • enforce_password_change (불리언): 다음 로그인 시 암호 변경 강제 여부
    • (날짜/시각) last_password_change: 마지막 암호 변경 일시
    • password_history_count (32비트 정수): 최근 암호 기억 횟수
    • password_expiration_interval (32비트 정수): 암호 만료 주기 (일자 단위)
    • is_enabled (불리언): 로그인 가능 여부
    • use_login_lock (불리언): 로그인 자동 차단 여부
    • **login_lock_count ** (32비트 정수): 계정 잠금 기준 로그인 실패 횟수
    • **login_failures ** (32비트 정수): 로그인 연속 실패 횟수
    • (날짜/시각) last_login_date_time: 마지막 로그인 성공 일시
    • (날짜/시각) last_login_failed_date_time : 마지막 로그인 실패 일시
    • use_idle_timeout (불리언): 세션 유휴 동작 사용 여부
    • **idle_timeout ** (32비트 정수): 세션 유휴 기준 시간 (초 단위)
    • use_logout_timeout (불리언): 세션 유휴 시 로그아웃 여부. 세션 유휴 기준 시간은 idle_timeout 값을 동일하게 사용합니다.
    • use_otp (불리언): OTP 사용 여부
    • otp_seed (문자열): OTP 토큰 생성 값
    • use_acl (불리언): IP 접근 제한 여부
    • trust_hosts (배열): 접속 허용된 IP 주소 목록
    • **grantable_menu_profiles ** (배열): 부여 가능 메뉴 프로파일 목록
    • settings (맵): 설정 키, 값 목록
    • (날짜/시각) created: 계정 생성 일시
    • (날짜/시각) updated: 계정 수정 일시

오류 응답

관리자 권한이 없는 경우
{
    "error_code": "security-violation",
    "error_msg": "you are not allowed to list users."
}
offset, limit 매개변수 값이 정수가 아닌 경우

offset

{
    "error_code": "invalid-argument",
    "error_msg": "'offset' parameter should be int type"
}

limit

{
    "error_code": "invalid-argument",
    "error_msg": "'limit' parameter should be int type"
}
검색 대상 부서가 존재하지 않는 경우
{
    "error_code": "org-unit-not-found",
    "error_msg": null
}