계정 그룹 조회

지정된 계정 그룹을 조회합니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/user-groups/28c1251b-2f7c-4c58-95a1-fc4a1ead877e

요청 매개변수

정상 응답

{
  "user_group": {
    "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",
    "user_guids": ["ffaf431b-653a-4329-8f83-913cbb00342d"],
    "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 (문자열): 계정 그룹을 만든 계정의 이름
  • user_guids (배열): 계정 그룹에 속한 계정 식별자 목록
  • created (문자열): 생성일시. yyyy-MM-dd HH:mm:ssZ 형식.
  • updated (문자열): 수정일시. yyyy-MM-dd HH:mm:ssZ 형식.

오류 응답

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

HTTP 상태 코드 400 응답

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

계정 그룹을 조회할 수 없는 경우

HTTP 상태 코드 200 응답

{
  "user_group": null
}