계정 일괄 삭제

지정한 계정을 삭제합니다. 이 작업은 일부 동작 실패를 허용합니다. 삭제하지 못한 계정이 있으면 failures 매개변수에 해당 계정의 식별자와 실패 원인을 반환합니다.

필요 권한

관리자 이상의 계정으로 이용할 수 있습니다. 단, 본인보다 상위 권한의 계정은 삭제할 수 없습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -X DELETE \
     "https://HOSTNAME/api/sonar/users?guids=6ba6031e-9d03-4a2b-8372-20ceee8f2a76"

요청 매개변수

정상 응답

{
  "failures": []
}

• failures (배열): 삭제하지 못한 계정의 오류 정보
  • guid (문자열): 계정 식별자
  • login (문자열): 로그인 계정 이름. 조회되지 않은 계정은 생략
  • name (문자열): 사용자 성명. 조회되지 않은 계정은 생략
  • reason (문자열): 실패 원인

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태 코드 400 응답

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

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

HTTP 상태 코드 400 응답

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

상위 권한의 계정 삭제를 시도한 경우

HTTP 상태 코드 200 응답

{
  "failures": [
    {
      "guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "login": "gildong",
      "name": "홍길동",
      "reason": "no-permission"
    }
  ]
}

자기 자신을 삭제 시도한 경우

HTTP 상태 코드 200 응답

{
  "failures": [
    {
      "guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "reason": "cannnot-remove-yourself"
    }
  ]
}

계정이 존재하지 않는 경우

HTTP 상태 코드 200 응답. 클러스터 관리자가 아닌 세션에서 다른 테넌트(회사)의 계정을 삭제하려고 시도한 경우에도 조회 실패로 처리합니다.

{
  "failures": [
    {
      "guid": "6ba6031e-9d03-4a2b-8372-20ceee8f2a75",
      "reason": "user not found: 6ba6031e-9d03-4a2b-8372-20ceee8f2a75"
    }
  ]
}