접속 프로파일 수정

지정한 접속 프로파일을 수정합니다.

필요 권한

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

HTTP 요청

PUT /api/sonar/connect-profiles/:guid
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
     -d name="Hyper SQL" \
     -d description="Embedded file database" \
     -d configs="{""connection_string"":""jdbc:hsqldb:file:testdb"", ""user"":""SA"", ""password"":""NEW_PASSWORD"", ""read_only"":false, ""update_keys"": [""password""]}" \
     -X PUT \
     https://HOSTNAME/api/sonar/connect-profiles/b7f00412-8720-4a8f-ac35-7d7f359f797e
요청 매개변수
필수타입설명비고
guidO문자열접속 프로파일 식별자36자
nameO문자열접속 프로파일 화면 표시 이름최소 1자, 최대 50자
descriptionX문자열접속 프로파일 설명최대 2,000자
grant_usersX문자열권한 부여된 계정 GUID 목록여러 개의 항목은 쉼표(,)로 구분
grant_groupsX문자열권한 부여된 계정 그룹 GUID 목록여러 개의 항목은 쉼표(,)로 구분
configsO문자열 키/값설정 값. 하단 설명 참조JSON 형식 문자열

접속 프로파일 수정 요청 시 보호되는 설정 키를 configs 매개변수에 포함하지 않으면, 이전의 설정 값을 그대로 유지합니다. 보호되는 설정 키를 새 값으로 수정하려면, configs 매개변수의 키/값 쌍에 update_keys 키와 보호 키 이름의 목록을 포함하여 전송해야 합니다.

update_keys 지시가 없으면 기존 설정 값을 유지하려고 null을 전송한 것인지 기존 설정 값을 삭제하려고 null을 전송한 것인지 구분할 수 없기 때문입니다.

정상 응답

{}

오류 응답

접속 프로파일이 존재하지 않는 경우
{
  "error_code": "profile-not-found",
  "error_msg": null
}
필수 매개변수가 누락된 경우
{
  "error_code": "null-argument",
  "error_msg": "name should be not null"
}
매개변수 값의 길이가 잘못된 경우
{
  "error_code": "invalid-argument",
  "error_msg": "'name' must be less than or equal to 50 characters."
}
필수 설정 값이 누락된 경우
{
  "error_code": "invalid-argument",
  "error_msg": "config option must be not null: connection_string"
}
관리 권한이 없는 회사를 지정한 경우
{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}