parseSamlIdpMetadata

이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.

Classic/VPC 환경에서 이용 가능합니다.

Ncloud 표준 표현을 적용한 API입니다.

External SAML IdP 메타데이터를 파싱합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/tenant/saml-idps/parse-metadata

요청 헤더

Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

요청 바디는 application/xml 형식입니다.

필드	타입	필수 여부	설명
-	String	-	External IdP 의 SAML 메타데이터 XML 본문 <예시> <?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://idp.example.com/saml"><md:IDPSSODescriptor>...</md:IDPSSODescriptor></md:EntityDescriptor>

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v2/tenant/saml-idps/parse-metadata' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/xml' \
--data-binary '@/path/to/request-body'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`requestSigningEnabled`	Boolean	-	AuthnRequest 서명 여부 `true` \| `false` true: 서명 false: 서명 안 함 <예시> true
`idpSigninUrl`	String (uri)	-	사용자가 SSO를 통해 로그인할 때 리디렉션되는 IdP의 로그인 URL <예시> https://sso.example.com
`idpIssuerUrl`	String (uri)	-	SAML 응답에서 발행자(Issuer)로 사용되는 URL <예시> https://sso.example.com
`idpSignoutUrl`	String (uri)	-	사용자가 SSO 로그아웃 시 리디렉션되는 IdP의 로그아웃 URL <예시> https://sso.example.com
`idpCertificates`	List<String>	-	SAML 응답의 서명을 검증하는 데 사용되는 IdP의 공개 인증서 목록 항목 <예시> MIICmzCCAYMCBgGN...
`signRequestAlgorithm`	String	-	SAML 요청을 서명할 때 사용하는 알고리즘 `RSA_SHA1` \| `RSA_SHA256` <예시> RSA_SHA1
`signResponseAlgorithm`	String	-	SAML 응답을 서명할 때 사용하는 알고리즘 `RSA_SHA1` \| `RSA_SHA256` <예시> RSA_SHA1
`protocolBinding`	String	-	SAML 요청과 응답을 전송할 때 사용하는 프로토콜 바인딩 `HTTP_POST` \| `HTTP_REDIRECT` HTTP_POST: SAML 메시지를 HTTP-POST 요청의 본문에 포함하여 전송하는 방식 HTTP_REDIRECT: SAML 메시지를 URL 쿼리 파라미터로 포함하여 HTTP-GET 요청을 통해 전송하는 방식 <예시> HTTP_POST

응답 상태 코드

Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	요청 처리 성공
400	InvalidMetadataFormat	The specified metadata format is invalid.	SAML 메타데이터 XML 형식 오류
400	InvalidConfiguration	Some or all of the configuration is incomplete, missing, or not valid.	SAML 메타데이터에 필수 요소(EntityID·SSO 서비스·서명 인증서 등) 누락
404	NotFound	One or more of the resources in the request does not exist in the system.	잘못된 URL 요청, 마스터 계정에 Organization이 존재하지 않음, 존재하지 않는 관리형 정책(System Managed) 아이디 입력, SSO User에 MFA Device가 존재하지 않음
404	ResourceNotFound	The specified resource could not be found.	생성된 Tenant가 없음, 존재하지 않는 자원 아이디 입력

응답 예시

응답 예시는 다음과 같습니다.

{
  "requestSigningEnabled": true,
  "idpSigninUrl": "https://sso.example.com",
  "idpIssuerUrl": "https://sso.example.com",
  "idpSignoutUrl": "https://sso.example.com",
  "idpCertificates": [
    "MIICmzCCAYMCBgGN..."
  ],
  "signRequestAlgorithm": "RSA_SHA1",
  "signResponseAlgorithm": "RSA_SHA1",
  "protocolBinding": "HTTP_POST"
}