SSO 프로바이더 설정 명세 조회

지정한 SSO 프로바이더가 정의한 설정 항목의 메타데이터를 조회합니다. 새 SSO 설정을 생성하거나 수정할 때 입력 폼을 구성하기 위한 정보를 제공합니다.

필요 권한

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

HTTP 요청

GET /api/sonar/sso-providers/:id/configs

cURL 예시

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

요청 매개변수

경로 매개변수

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

정상 응답

{
  "configs": [
    {
      "name": "idp_url",
      "display_name": "IdP URL",
      "description": "SAML IdP 엔드포인트",
      "type": "string",
      "subtype": null,
      "required": true,
      "protected": false,
      "default_value": null,
      "min": null,
      "max": null
    },
    {
      "name": "client_secret",
      "display_name": "클라이언트 비밀키",
      "description": "",
      "type": "string",
      "subtype": null,
      "required": true,
      "protected": true,
      "default_value": null,
      "min": null,
      "max": null
    }
  ]
}

configs (배열): 설정 명세 목록
- name (문자열): 설정 키
- display_name (문자열): 로케일이 적용된 화면 표시 이름
- description (문자열): 로케일이 적용된 화면 표시 설명
- type (문자열): 데이터 타입
- subtype (문자열): UI에서 인식하는 확장 컴포넌트 유형
- required (불리언): 필수 여부
- protected (불리언): 보호 설정 여부. password 등 조회 시 노출되면 안 되는 항목은 true
- default_value (객체): 기본값. subtype이 enum인 경우 null
- selectable (객체): subtype이 enum인 경우 선택 가능한 값 목록
- min (숫자): 최솟값 제약
- max (숫자): 최댓값 제약

오류 응답

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": "no-permission"
}