Documentation Index

Fetch the complete documentation index at: https://api-fin.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

External IDP 메타데이터 파싱

Prev Next

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

요청

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

메서드 URI
POST /api/v1/tenant/saml-idp/metadata-parsing

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
EntityDescriptor.xmlns:md String Required XML namespace 정보
  • urn:oasis:names:tc:SAML:2.0:metadata (유효 값)
EntityDescriptor.entityID String Required IdP 엔티티의 고유 식별자
EntityDescriptor.IDPSSODescriptor.WantAuthnRequestsSigned Boolean Optional AuthnRequest에 서명 여부
  • true | false
    • true: 서명
    • false: 서명 안 함
EntityDescriptor.IDPSSODescriptor.protocolSupportEnumeration String Required 지원 프로토콜
  • urn:oasis:names:tc:SAML:2.0:protocol (유효 값)
EntityDescriptor.IDPSSODescriptor.KeyDescriptor.use String Required 인증서 용도
  • signing (유효 값)
EntityDescriptor.IDPSSODescriptor.KeyDescriptor.KeyInfo.xmlns:ds String Required KeyInfo namespace 정보
  • http://www.w3.org/2000/09/xmldsig# (유효 값)
EntityDescriptor.IDPSSODescriptor.KeyDescriptor.KeyInfo.X509Data.X509Certificate String Required IdP 서명용 X.509 인증서
EntityDescriptor.IDPSSODescriptor.SingleSignOnService.Binding String Required SAML 로그인 시 프로토콜 바인딩 정보
  • urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST | urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
    • urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST: HTTP-POST 방식
    • urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect: HTTP-Redirect 방식
EntityDescriptor.IDPSSODescriptor.SingleSignOnService.Location String Required 바인딩 프로토콜에 매핑되는 SAML 로그인 URL

요청 예시

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

curl --location --request POST 'https://sso.apigw.fin-ntruss.com/api/v1/tenant/saml-idp/metadata-parsing' \
--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 '<?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx">
  <md:IDPSSODescriptor WantAuthnRequestsSigned="false" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
    <md:KeyDescriptor use="signing">
      <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
        <ds:X509Data>
          <ds:X509Certificate>MII******************vkhgLE=</ds:X509Certificate>
        </ds:X509Data>
      </ds:KeyInfo>
    </md:KeyDescriptor>
    <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://portal.sso.ap-southeast-2.amazonaws.com/saml/logout/MDUwNzUy****************************ZTU0NTkx"/>
    <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://portal.sso.ap-southeast-2.amazonaws.com/saml/logout/MDUwNzUy****************************ZTU0NTkx"/>
    <md:NameIDFormat/>
    <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx"/>
    <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx"/>
  </md:IDPSSODescriptor>
</md:EntityDescriptor>'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
signRequest Boolean - AuthnRequest에 서명 여부
  • true | false
    • true: 서명
    • false: 서명 안 함
providerId String - IdP의 고유 식별자
idpSigninUrl String - 사용자가 SSO를 통해 로그인할 때 리디렉션되는 IdP의 로그인 URL
idpIssuerUrl String - SAML 응답에서 발행자(Issuer)로 사용되는 URL
idpCert String - SAML 응답의 서명을 검증하는 데 사용되는 IdP의 공개 인증서 (deprecated)
idpCerts String - SAML 응답의 서명을 검증하는 데 사용되는 IdP의 공개 인증서 목록
signRequestAlgorithm String - SAML 요청을 서명할 때 사용하는 해시 알고리즘
  • signRequesttrue일 때 표시
  • SHA-1 | SHA-256
    • SHA-1: SHA-1 해시 알고리즘
    • SHA-256: SHA-256 해시 알고리즘
signResponseAlgorithm String - SAML 응답을 서명할 때 사용하는 해시 알고리즘
  • SHA-1 | SHA-256
    • SHA-1: SHA-1 해시 알고리즘
    • SHA-256: SHA-256 해시 알고리즘
protocolBinding String - SAML 요청과 응답을 전송할 때 사용하는 프로토콜 바인딩
  • HTTP-POST | HTTP-REDIRECT
    • HTTP-POST: SAML 메시지를 HTTP-POST 요청의 본문에 포함하여 전송하는 방식
    • HTTP-REDIRECT: SAML 메시지를 URL 쿼리 파라미터로 포함하여 HTTP-GET 요청을 통해 전송하는 방식

응답 상태 코드

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

응답 예시

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

{
    "signRequest": false,
    "idpSigninUrl": "https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx",
    "idpIssuerUrl": "https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx",
    "idpCerts": ["MII******************vkhgLE="],
    "signResponseAlgorithm": "SHA-256",
    "protocolBinding": "HTTP-POST"
}