ID 공급자 유형 설정 명세 조회

지정한 ID 공급자 유형이 정의한 설정 항목의 메타데이터를 조회합니다. 새 SSO 설정을 생성하거나 수정할 때 입력 폼을 구성하기 위한 정보를 제공합니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/id-provider-factories/saml/configs

요청 매개변수

정상 응답

{
  "configs": [
    {
      "name": "identifier",
      "display_name": "식별자",
      "description": "계정 매칭 식별자 (login 또는 email)",
      "type": "string",
      "subtype": null,
      "required": true,
      "protected": false,
      "default_value": null,
      "min": null,
      "max": null
    },
    {
      "name": "create_user",
      "display_name": "계정 생성 여부",
      "description": "계정 생성 여부",
      "type": "boolean",
      "subtype": null,
      "required": true,
      "protected": false,
      "default_value": null,
      "min": null,
      "max": null
    },
    {
      "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 (문자열): 데이터 타입. string, integer, boolean 중 하나
  • subtype (문자열): UI에서 인식하는 확장 컴포넌트 유형. 지정되지 않으면 null
  • required (불리언): 필수 여부
  • protected (불리언): 보호 설정 여부. 암호처럼 조회 시 노출되면 안 되는 항목은 true
  • default_value (문자열): 기본값. subtype이 enum인 경우 null
  • selectable (문자열): 선택 가능한 값 목록. subtype이 enum인 경우에만 포함
  • min (숫자): 최솟값 제약. 제약이 없으면 null
  • max (숫자): 최댓값 제약. 제약이 없으면 null

설정 항목 목록 맨 앞에는 ID 공급자 유형과 무관하게 소나가 공통으로 추가하는 필수 항목 두 개가 옵니다. 두 항목은 모두 필수 항목이므로 subtype, default_value, min, max가 모두 null입니다.

• identifier: 계정 매칭에 사용할 식별자. login 또는 email로 해석하며, 값이 지정되지 않으면 email로 간주합니다
• create_user: 매칭되는 계정이 없을 때 계정을 자동으로 생성할지 여부

공통 항목 뒤에는 해당 ID 공급자 유형이 정의한 설정 항목이 이어집니다. 이 엔드포인트는 설정 항목의 정의만 반환하며 저장된 값은 포함하지 않습니다. 저장된 값을 함께 확인하려면 ID 공급자 조회를 사용하십시오.

오류 응답

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

HTTP 상태 코드 400 응답

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

권한이 없는 경우

HTTP 상태 코드 500 응답

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

ID 공급자 유형 조회가 권한 검사보다 먼저 수행되므로, SSO 조회 권한이 없는 계정도 등록되지 않은 코드를 요청하면 권한 오류가 아니라 provider not found 오류를 먼저 받습니다.