ID 공급자 유형 설정 검증

지정한 ID 공급자 유형의 설정값이 필수 항목과 공급자 구현의 자체 검증 규칙을 만족하는지 검사합니다. 설정을 저장하거나 상태를 바꾸지 않으므로, 생성·수정 전에 입력값을 미리 점검할 때 사용합니다. 다만 공급자 구현의 검증 절차가 외부 시스템에 접속할 수 있으므로 실제 부작용 여부는 공급자 구현에 달렸습니다.

검증을 통과하면 빈 객체와 HTTP 상태 코드 200을 반환합니다. 검증 결과를 담은 필드는 없으므로 성공과 실패는 HTTP 상태 코드와 error_code로 구분합니다.

configs에는 공급자 유형이 정의한 필수 옵션과 함께 모든 유형에 공통으로 적용되는 identifier, create_user가 반드시 들어가야 합니다. 하나라도 빠지면 검증에 실패합니다.

필요 권한

로그인한 계정이면 호출할 수 있습니다. 별도의 SSO 권한은 필요하지 않지만, 로그인하지 않은 요청은 HTTP 상태 코드 401로 거부됩니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d 'configs={"identifier": "email", "create_user": true, "idp_url": "https://idp.example.com/saml", "client_secret": "secret-value"}' \
     -X POST https://HOSTNAME/api/sonar/id-provider-factories/saml/configs/validate

요청 매개변수

경로 매개변수

요청 본문 매개변수

정상 응답

{}

오류 응답

공급자 구현의 자체 검증이 실패한 경우 반환되는 오류 코드와 메시지는 공급자 구현에 따라 다릅니다.

configs가 누락된 경우

HTTP 상태 코드 400 응답

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

configs가 올바른 JSON 객체가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'configs' parameter should follow valid JSON syntax"
}

ID 공급자 유형이 존재하지 않는 경우

HTTP 상태 코드 400 응답

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

필수 설정 항목이 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "idp_url is required"
}