Trust Anchor 수정

Prev Next

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

Trust Anchor 정보를 수정합니다.

요청

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

메서드 URI
PATCH /api/v1/trust-anchors/{trustAnchorId}

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
trustAnchorId String Required Trust Anchor 아이디

요청 바디

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

필드 타입 필수 여부 설명
name String Optional Trust Anchor 이름
  • 한글, 영어 대소문자, 일어, 특수문자 . _ -를 사용하여 3~30자
  • 첫 글자는 한글, 영어 대소문자, 일어
description String Optional Trust Anchor에 대한 설명(Bytes)
  • 0~300
source Object Optional CA 정보
source.sourceType String Required CA 유형
  • NCP_PCA | CERTIFICATE_BUNDLE
    • NCP_PCA: 네이버 클라우드 플랫폼의 Private CA를 사용하는 경우
    • CERTIFICATE_BUNDLE: 사용자가 외부에서 생성한 CA를 사용하는 경우
source.sourceData Object Optional CA 대상 정보
source.sourceData.caId Integer Optional 네이버 클라우드 플랫폼 Private CA 아이디
  • sourceType: NCP_PCA인 경우
source.sourceData.x509CertificateData String Optional 사용자가 외부에서 생성한 CA 인증서 데이터
  • PEM 형식
  • sourceType: CERTIFICATE_BUNDLE인 경우

요청 예시

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

  • source.sourceType이 NCP_PCA인 경우
curl --location --request PATCH 'https://externalaccess.apigw.gov-ntruss.com/api/v1/trust-anchors/a271f5b5-****-****-****-bda95123e58e' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "name": "ta000",
    "description": "Trust Anchor",
    "source": {
        "sourceType": "NCP_PCA",
        "sourceData": {
            "caId": ****
        }
    }
}'
  • source.sourceType이 CERTIFICATE_BUNDLE인 경우
    curl --location --request PATCH 'https://externalaccess.apigw.gov-ntruss.com/api/v1/trust-anchors/a271f5b5-****-****-****-bda95123e58e' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "name": "ta000",
    "description": "Trust Anchor",
    "source": {
        "sourceType": "CERTIFICATE_BUNDLE",
        "sourceData": {
            "x509CertificateData": "-----BEGIN CERTIFICATE-----\n{CA}\n-----END CERTIFICATE-----"
        }
    }
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
trustAnchorId String - Trust Anchor 아이디
trustAnchorNrn String - Trust Anchor에 대한 네이버 클라우드 플랫폼 리소스 식별 값
name String - Trust Anchor 이름
description String - Trust Anchor에 대한 설명
enabled Boolean - 상태
  • true | false
    • true: 활성화
    • false: 비활성화
createTime String - 생성 일시
  • ISO 8601 형식
updateTime String - 마지막 수정 일시
  • ISO 8601 형식
source Object - CA 정보
source.sourceType String - CA 유형
  • NCP_PCA | CERTIFICATE_BUNDLE
    • NCP_PCA: 네이버 클라우드 플랫폼의 Private CA를 사용하는 경우
    • CERTIFICATE_BUNDLE: 사용자가 외부에서 생성한 CA를 사용하는 경우
source.sourceData Object - CA 대상 정보
source.sourceData.caId Integer - 네이버 클라우드 플랫폼 Private CA의 아이디
  • sourceType: NCP_PCA인 경우
source.sourceData.x509CertificateData String - 사용자가 외부에서 생성한 CA 인증서 데이터
  • PEM 형식
  • sourceType: CERTIFICATE_BUNDLE인 경우

응답 상태 코드

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

응답 예시

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

  • source.sourceType이 NCP_PCA인 경우

    {
    "trustAnchorId": "a271f5b5-****-****-****-bda95123e58e",
    "trustAnchorNrn": "nrn:PUB:ExternalAccess::*******:TrustAnchor/a271f5b5-****-****-****-bda95123e58e",
    "name": "ta000",
    "description": "test",
    "enabled": false,
    "createTime": "2024-12-13T13:16:50.330726376+09:00",
    "updateTime": "2024-12-13T13:16:50.330726376+09:00",
    "source": {
        "sourceType": "NCP_PCA",
        "sourceData": {
            "caId": *****
        }
    }
}

  • source.sourceType이 CERTIFICATE_BUNDLE인 경우

    {
    "trustAnchorId": "a271f5b5-****-****-****-bda95123e58e",
    "trustAnchorNrn": "nrn:PUB:ExternalAccess::*******:TrustAnchor/a271f5b5-****-****-****-bda95123e58e",
    "name": "ta000",
    "description": "test",
    "enabled": false,
    "createTime": "2024-12-13T13:16:50.330726376+09:00",
    "updateTime": "2024-12-13T13:16:50.330726376+09:00",
    "source": {
        "sourceType": "CERTIFICATE_BUNDLE",
        "sourceData": {
            "x509CertificateData": "-----BEGIN CERTIFICATE-----\n{CA}\n-----END CERTIFICATE-----"
        }
    }
}