SSO 프로바이더 비활성화

활성화된 SSO 프로바이더를 비활성화하여 로그인 화면 진입점에서 제거합니다. 설정값은 그대로 유지되며, 다시 활성화 API를 호출하면 동일한 설정으로 재활성화됩니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -X PUT \
     https://HOSTNAME/api/sonar/sso-providers/saml/disable

요청 매개변수

경로 매개변수

| 키 | 타입 | 설명 | 비고 | | -- | ------ | ------------------- | ---- | | id | 문자열 | SSO 프로바이더 식별자 | |

정상 응답

{}

오류 응답

id가 누락된 경우

HTTP 상태 코드 400 응답

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

프로바이더가 존재하지 않는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-argument",
  "error_msg": "provider not found: saml"
}

등록된 설정이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "SSO provider config not found: saml"
}

권한이 없는 경우

HTTP 상태 코드 500 응답

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