External IDP 수정

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

External SAML IdP를 수정합니다.

요청

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

메서드	URI
PUT	/api/v1/tenant/saml-idp

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`signRequest`	Boolean	Optional	AuthnRequest에 서명 여부 `true` \| `false` `true`: 서명 `false`: 서명 안 함
`idpSigninUrl`	String	Required	SSO를 통한 로그인 시 리디렉션되는 IdP의 로그인 URL 1~1000자
`idpIssuerUrl`	String	Required	SAML 로그인 시 발행자(Issuer)로 사용되는 URL 1~1000자
`idpCert`	String	Required	SAML 로그인 시 서명을 검증하는 데 사용되는 IdP의 공개 인증서 1~2000자
`signRequestAlgorithm`	String	Conditional	SAML 요청 서명 시 사용하는 해시 알고리즘 `signRequest`가 `true`면 필수 `SHA-1` \| `SHA-256` `SHA-1`: SHA-1 해시 알고리즘 `SHA-256`: SHA-256 해시 알고리즘
`signResponseAlgorithm`	String	Required	SAML 응답 서명 시 사용하는 해시 알고리즘 `SHA-1` \| `SHA-256` `SHA-1`: SHA-1 해시 알고리즘 `SHA-256`: SHA-256 해시 알고리즘
`protocolBinding`	String	Required	SAML 로그인 시 사용하는 프로토콜 바인딩 `HTTP-POST` \| `HTTP-REDIRECT` `HTTP-POST`: SAML 메시지를 HTTP-POST 요청의 본문에 포함하여 전송하는 방식 `HTTP-REDIRECT`: SAML 메시지를 URL 쿼리 파라미터로 포함하여 HTTP-GET 요청을 통해 전송하는 방식

요청 예시

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

curl --location --request PUT 'https://sso.apigw.gov-ntruss.com/api/v1/tenant/saml-idp' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "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",
    "idpCert" : "{Certificate}",
    "signResponseAlgorithm" : "SHA-1",
    "protocolBinding" : "HTTP-POST"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`success`	Boolean	-	API 처리 결과 `true` \| `false` `true`: 성공 `false`: 실패
`message`	String	-	결과 메시지 `success`가 `false`인 경우, 표시

응답 상태 코드

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

응답 예시

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

{
    "success": true
}