계정 그룹 수정

지정한 계정 그룹의 정보를 수정합니다. 새 계정 그룹은 계정 그룹 생성 API로 만들 수 있습니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d name="Cyber Security" \
     -d user_guids=b2c3d4e5-f6a7-8901-bcde-f12345678901 \
     -X PUT \
     https://HOSTNAME/api/sonar/user-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890

요청 매개변수

경로 매개변수

요청 본문 매개변수

user_guids를 전송하면 계정 그룹의 소속 계정이 전송한 목록으로 교체됩니다. user_guids를 생략하거나 빈 값으로 전송하면 기존 소속 계정이 모두 제거됩니다.

수정 요청 시 소속 계정 전체를 다시 지정해야 하므로, 일부 계정만 추가하거나 제거하려는 경우에도 유지할 계정을 모두 포함한 목록을 전송해야 합니다.

정상 응답

{}

오류 응답

name이 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "name should be not null"
}

name 또는 description 값의 길이가 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'name' must be shorter than or equal to 200 characters."
}

guid가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

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

user_guids 값이 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

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

계정 그룹이 존재하지 않는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "user group not found: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

name이 중복된 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "duplicated user group name: Cyber Security"
}

권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}