계정 그룹 목록 조회

검색 조건과 일치하는 계정 그룹 목록을 조회합니다.

HTTP 요청

GET /api/sonar/user-groups

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/user-groups

요청 매개변수

키	필수	타입	설명	비고
offset	X	32비트 정수	건너뛸 갯수	기본값 0
limit	X	32비트 정수	최대 갯수	미지정 시 전체 조회
keywords	X	문자열	검색 키워드	name, description 대상으로 검색
company_guid	X	문자열	회사 GUID	클러스터 관리자 계정만 필터 적용됨
guids	X	문자열 목록	계정 그룹 GUID 목록	여러 개의 GUID는 쉼표(`,`)로 구분

정상 응답

{
  "total_count": 1,
  "user_groups": [
    {
      "company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
      "company_name": "Logpresso",
      "guid": "28c1251b-2f7c-4c58-95a1-fc4a1ead877e",
      "name": "Cyber Security",
      "description": "",
      "owner_guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "owner_name": "Yang",
      "created": "2022-09-01 01:08:00+0900",
      "updated": "2022-09-01 01:08:00+0900"
    }
  ]
}

total_count (32비트 정수): 검색 조건과 일치하는 전체 건수
groups (배열): 계정 그룹 목록
- company_guid (문자열): 회사(테넌트)의 식별자
- company_name (문자열): 회사(테넌트)의 이름
- guid (문자열): 계정 그룹의 식별자
- name (문자열): 계정 그룹의 이름
- description (문자열): 설명
- owner_guid (문자열): 계정 그룹을 만든 계정의 식별자
- owner_name (문자열): 계정 그룹을 만든 계정의 이름
- created (문자열): 생성일시. yyyy-MM-dd HH:mm:ssZ 형식.
- updated (문자열): 수정일시. yyyy-MM-dd HH:mm:ssZ 형식.

오류 응답

offset, limit 값이 정수가 아닌 경우

HTTP 상태 코드 400 응답

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

offset, limit 값이 음수인 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}