Secret Manager 개요

Prev Next

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

Secret Manager는 보안 암호를 안전하게 관리할 수 있는 네이버 클라우드 플랫폼의 서비스입니다. Secret Manager 서비스에서는 보안 암호의 생성, 조회, 교체 및 삭제 관리와 관련된 API를 RESTful 형태로 제공합니다.

Secret Manager 공통 설정

Secret Manager API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

https://secretmanager.apigw.ntruss.com

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
  • API Gateway 서버와 5분 이상 시간 차 발생 시 유효하지 않은 요청으로 간주
  • Unix Timestamp 형식
x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 Access Key에 매핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
Content-Type Optional 요청 데이터의 형식
  • application/json

응답

공통 응답 형식을 설명합니다.

응답 바디

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

responseError
responseError는 API 호출 실패 정보를 정의합니다. responseError에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
error Object - 오류 정보
error.errorCode String - 오류 코드
error.message String - 오류 메시지
error.details String - 오류에 대한 상세 정보

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명
403 FORBIDDEN Forbidden 인증 완료이나 권한 없음으로 요청 거부
500 INTERNAL_SERVER_ERROR Server internal error 서버 내부 오류
422 UNPROCESSABLE_ENTITY Invalid status 요청은 유효하나 규칙 위반
400 INVALID_REQUEST Invalid request 잘못된 요청
401 UNAUTHORIZED Unauthorized 인증 정보 누락
404 NOT_FOUND Not found 요청 리소스 없음
409 INVALID_STATUS Invalid status 유효하지 않은 상태 값
참고

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.

{
  "error": {
    "errorCode": "string",
    "message": "string",
    "details": "string"
  }
}

Secret Manager API

Secret Manager 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

API 설명
Create Secret 시크릿 생성
Get Protection Key List 보호 키 목록 조회
Get Secret Detail 시크릿 상세 정보 조회
Get Secret List 시크릿 목록 조회
Get Secret Logs 시크릿 이용 로그 조회
Get Secret Stage Value 특정 시크릿 스테이지의 시크릿 값 조회
Get Secret Value 시크릿 값 조회
Get Trigger List 트리거 목록 조회
Cancel Rotation Job 실행 중인 시크릿 교체 작업 취소
Cancel Secret Deletion 시크릿 삭제 요청 취소
Disable Auto Rotation 시크릿 자동 교체 비활성화
Disable Secret 시크릿 비활성화
Enable Auto Rotation 시크릿 자동 교체 활성화
Enable Secret 시크릿 활성화
Execute Rotation Job 시크릿 교체 작업 실행
Request Secret Deletion 시크릿 삭제 요청 생성
Retry Rotation Job 시크릿 교체 작업 재시도
Rollback Rotation Job 시크릿 교체 작업 롤백
Update Protection Key 보호 키 변경
Update Rotation Period 시크릿 교체 주기 변경
Update Rotation Trigger 시크릿 교체 트리거 변경
Update Secret Memo 시크릿 설명 수정
Update Secret Stage Value 특정 시크릿 스테이지의 시크릿 값 수정
Update Secret Value 전체 시크릿 스테이지의 시크릿 값 변경
Delete Rotation Trigger 시크릿 교체 트리거 삭제
Delete Secret 시크릿 삭제

Secret Rotate Process Control

Secret Rotate Process Control 관련 API에 대한 설명은 다음과 같습니다.

API 설명
Add Pending Stage Pending 스테이지 생성
Generate Random Secret 임의의 시크릿 문자열 생성
Complete Rotation Job 시크릿 교체 작업 완료 통보
Fail Rotation Job 시크릿 교체 작업 실패 통보
Start Rotation Job 시크릿 교체 작업 시작
Update Pending Stage Pending 스테이지의 시크릿 값 수정

Secret Manager 연관 리소스

Secret Manager API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.