계정 조회

지정된 식별자의 계정을 조회합니다.

필요 권한

사용자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

GET /api/sonar/users/:guid

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/users/ffaf431b-653a-4329-8f83-913cbb00342d

요청 매개변수

키	필수	타입	설명	비고
guid	O	문자열	계정 식별자

정상 응답

{
  "user": {
    "guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
    "login": "gildong",
    "name": "홍길동",
    "title": null,
    "dept": null,
    "phone": null,
    "mobile": null,
    "email": "gildong@example.com",
    "locale": null,
    "role_id": 1,
    "role_name": "클러스터 관리자",
    "home_menu_id": 18,
    "granted_tables": [
      {
        "type": "TABLE",
        "name": "weblog",
        "read_only": true,
        "created": "2022-09-11 21:23:45+0900"
      }
    ],
    "user_granted_profiles": [
      {
        "type": "PROFILE",
        "guid": "2011297e-6a3f-45de-92a3-8c187edb62d2",
        "name": "testdb (데이터베이스)",
        "read_only": true,
        "created": "2022-09-11 21:23:45+0900"
      }
    ],
    "group_granted_profiles": [],
    "user_group_guids": ["28c1251b-2f7c-4c58-95a1-fc4a1ead877e"],
    "trust_hosts": [],
    "idle_behavior": "lock",
    "idle_timeout": 3600,
    "password_expiration": 7,
    "last_pw_change": "2022-09-11 21:08:39+0900",
    "login_lock_count": 5,
    "login_lock_interval": 10,
    "old_passwd_count": 0,
    "login_lock_until": null,
    "login_fail_count": 0,
    "last_login": "2022-09-11 21:10:02+0900",
    "last_deactivate_unlock": null,
    "is_deactivated": false,
    "auth_mode": 0,
    "has_api_key": true,
    "api_key": "3c9e8f7a-1b2c-4d3e-9f8a-7b6c5d4e3f2a",
    "preferences": {},
    "created": "2022-09-01 00:31:13+0900",
    "updated": "2022-09-11 21:08:39+0900",
    "mfa_enabled": false,
    "mfa_type": null,
    "otp_registered": false,
    "max_concurrent_queries": null,
    "max_query_row_limit": null
  }
}

user (맵): 계정
- guid (문자열): 계정 고유 식별자
- login (문자열): 로그인 계정 이름
- name (문자열): 사용자 성명
- title (문자열): 직함
- dept (문자열): 부서
- phone (문자열): 유선 전화번호
- mobile (문자열): 휴대 전화번호
- email (문자열): 이메일
- locale (문자열): 언어. en 혹은 ko
- role_id (32비트 정수): 역할 ID. 게스트 (0), 클러스터 관리자 (1), 관리자 (2), 사용자 (3)
- role_name (문자열): 역할 이름
- home_menu_id (32비트 정수): 로그인 후 표시할 메뉴 ID
- (배열) granted_tables
  - type (문자열): TABLE 고정
  - name (문자열): 테이블 이름
  - read_only (불리언): 읽기 전용 여부
  - created (문자열): 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- (배열) user_granted_profiles
  - type (문자열): PROFILE 고정
  - guid (문자열): 프로파일 식별자
  - name (문자열): 프로파일 이름
  - read_only (불리언): 읽기 전용 여부
  - created (문자열): 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- (배열) group_granted_profiles
  - type (문자열): PROFILE 고정
  - guid (문자열): 프로파일 식별자
  - name (문자열): 프로파일 이름
  - read_only (불리언): 읽기 전용 여부
  - created (문자열): 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- user_group_guids (배열): 계정이 속한 계정 그룹 식별자 목록
- trust_hosts (문자열): 신뢰하는 호스트 주소 목록. IP 주소가 설정된 경우 해당 IP 주소 이외의 로그인을 허용하지 않습니다.
- idle_behavior (문자열): 세션 유휴 시 보호 동작. 화면 잠금 (lock), 자동 로그아웃 (logout)
- idle_timeout (32비트 정수): 초 단위의 세션 유휴 기준 시각. 값은 0부터 최대 604800초의 범위이며, 0은 무제한을 의미합니다.
- password_expiration (32비트 정수): 암호 만료 기준 일자 수. 시스템 기본값 적용 (-1), 무제한 (0), 최소 7일부터 최대 3650일 이하의 값을 사용합니다.
- last_pw_change (문자열): 마지막 암호 변경일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- login_lock_count (32비트 정수): 로그인 잠금 기준 횟수. 최소 0부터 최대 5회의 값을 사용합니다. 0인 경우 인증 실패 시 즉시 로그인이 잠깁니다.
- login_lock_interval (32비트 정수): 로그인 잠금 유지 시간. 최소 1분부터 최대 100000000분 이하의 값을 사용합니다.
- old_passwd_count (32비트 정수): 암호 기억 개수. 최근 사용한 암호와 동일한 암호로 다시 변경하지 못하도록 기억하는 이전 암호의 개수
- login_lock_until (문자열): 계정 잠금 해제 일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- login_fail_count (32비트 정수): 로그인 연속 실패 횟수
- last_login (문자열): 마지막 로그인 일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- last_deactivate_unlock (문자열): 마지막 비활성화 해제 일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- is_deactivated (불리언): 계정 비활성화 여부
- auth_mode (32비트 정수): 인증 모드. 모든 인증 방식 시도 (0), 외부 인증 전용 (1)
- has_api_key (불리언): API 키 존재 여부
- api_key (문자열): API 키 값. API 키가 없으면 null
- preferences (맵): 개인화 설정 목록
- created (문자열): 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- updated (문자열): 수정일시 (yyyy-MM-dd HH:mm:ssZ 형식)
- mfa_enabled (불리언): MFA 사용 여부
- mfa_type (문자열): MFA 인증 종류. OTP, PASSWORD, MAIL, SMS 중 하나이며 미설정 시 null
- otp_registered (불리언): OTP 시드 등록 여부
- max_concurrent_queries (32비트 정수): 동시 실행 가능한 adhoc 쿼리 최대 수. null이면 무제한
- max_query_row_limit (32비트 정수): 쿼리 메뉴에서 선택 가능한 최대 결과 건수. 10000, 100000, 1000000 중 하나이며 null이면 무제한

오류 응답

계정 식별자가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}

계정이 없거나 조회 권한이 없는 경우

HTTP 상태 코드 200 응답

{
  "user": null
}