이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.
Classic/VPC 환경에서 이용 가능합니다.
Ncloud 표준 표현을 적용한 API입니다.
IdP 인증서를 등록합니다. 테넌트당 최대 2장까지 등록할 수 있습니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /tenant/saml-idps/{providerId}/idp-certificates |
요청 헤더
Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
providerId |
String (uuid) | Required | External IdP 아이디
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
certificate |
String | Required | SAML 로그인 시 서명을 검증하는 데 사용되는 IdP의 공개 인증서. PEM 의 BEGIN/END 헤더와 개행을 제외한 Base64 본문
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://sso.apigw.ntruss.com/api/v2/tenant/saml-idps/8192a3b4-8888-4123-9456-789abcdef012/idp-certificates' \
--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/json' \
--data '{
"certificate": "MIID**********q1QPA=="
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
certificateId |
String (uuid) | - | 인증서의 고유 식별자
|
certificate |
String | - | 인증서
|
createdDateTime |
String (date-time) | - | IdP 인증서 생성 일시
|
expireDateTime |
String (date-time) | - | IdP 인증서 만료 일시
|
응답 상태 코드
Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.
이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 201 | - | - | 자원 생성 성공 |
| 400 | ResourceLimitExceeded | The request exceeds the resource limit. | 생성 가능한 자원 수 초과, SP·IdP 인증서 2장 초과 |
| 400 | InvalidCertificateFormat | The specified certificate format is invalid. | 인증서 형식 오류(Base64 인코딩 DER 아님), 만료된 SP 인증서 활성화 |
| 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가 없음, 존재하지 않는 자원 아이디 입력 |
| 409 | AlreadyExists | The resource with the name requested already exists. | 이미 사용 중인 이름·Tenant 별칭·로그인 아이디 입력, 이미 생성된 External IdP 또는 이미 등록된 IdP 인증서 |
응답 예시
응답 예시는 다음과 같습니다.
{
"certificateId": "708192a3-7777-4012-8345-6789abcdef01",
"certificate": "MIID**********q1QPA==",
"createdDateTime": "2025-01-02T09:00:00Z",
"expireDateTime": "2025-01-02T09:00:00Z"
}