ID 공급자 조회
지정한 ID 공급자의 기본 정보와 설정 명세, 현재 설정값을 함께 조회합니다. protected로 표시된 설정 키는 값이 마스킹된 상태로 반환됩니다.
필요 권한
관리자 이상의 계정으로 이용할 수 있습니다.
HTTP 요청
GET /api/sonar/id-providers/:code
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
https://HOSTNAME/api/sonar/id-providers/saml
요청 매개변수
경로 매개변수
| 키 | 타입 | 설명 | 비고 |
|---|---|---|---|
| code | 문자열 | ID 공급자 코드 | - |
요청 본문 매개변수
| 키 | 필수 | 타입 | 설명 | 비고 |
|---|---|---|---|---|
| locale | X | 문자열 | 로케일 | - |
정상 응답
{
"code": "saml",
"name": "SAML",
"path": "/sonar/sso/saml",
"icon": "iVBORw0KGgoAAAANSUhEUgAA...",
"enabled": true,
"description": "본사 SAML IdP 연동",
"created": "2026-04-01T10:00:00+0900",
"updated": "2026-04-15T09:00:00+0900",
"configs": [
{
"name": "idp_url",
"protected": false,
"value": "https://idp.example.com/saml",
"type": "string",
"subtype": null,
"required": true,
"display_name": "IdP URL",
"description": "SAML IdP 엔드포인트",
"default_value": null,
"min": null,
"max": null
},
{
"name": "client_secret",
"protected": true,
"value": "",
"type": "string",
"subtype": null,
"required": true,
"display_name": "클라이언트 비밀키",
"description": "",
"default_value": null,
"min": null,
"max": null
}
]
}
- code (문자열): ID 공급자 코드
- name (문자열): 로케일이 적용된 표시 이름
- path (문자열): SSO 로그인 진입 경로
- icon (문자열): Base64로 인코딩된 아이콘 이미지. 아이콘이 없으면
null - enabled (불리언): 활성화 여부
- description (문자열): 사용자가 입력한 설명
- created (날짜): 생성 시각
- updated (날짜): 마지막 수정 시각
- configs (배열): 공급자 설정 명세와 현재 값
- name (문자열): 설정 키
- protected (불리언): 보호 설정 여부.
true인 경우value는 마스킹되어 빈 문자열로 반환 - value (객체): 현재 설정값. 보호 설정인 경우 빈 문자열
- type (문자열): 데이터 타입
- subtype (문자열): UI에서 인식하는 확장 컴포넌트 유형
- required (불리언): 필수 여부
- display_name (문자열): 로케일이 적용된 화면 표시 이름
- description (문자열): 로케일이 적용된 화면 표시 설명
- default_value (객체): 기본값.
subtype이enum인 경우null - selectable (객체):
subtype이enum인 경우 선택 가능한 값 목록 - min (숫자): 최솟값 제약
- max (숫자): 최댓값 제약
오류 응답
code가 누락된 경우
HTTP 상태 코드 400 응답
{
"error_code": "null-argument",
"error_msg": "code 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"
}