본문으로 건너뛰기

KMS

KMS API의 호출 주소와 리소스별 작업을 안내합니다. 각 API 링크에서 요청 파라미터, 본문 스키마와 응답을 확인할 수 있습니다.

기본 URL​

https://key-management-service.kr-central-2.kakaocloud.com

리소스별 API​

키, 키 버전, 공개 키 등 주요 리소스의 API를 선택하면 요청 정보와 응답 형식을 확인할 수 있습니다.

KMS​

프로젝트의 KMS 서비스를 활성화하고 상태를 확인합니다.

API설명
Activate KMS serviceKMS 서비스를 활성화합니다.
Get KMS service statusKMS 서비스 활성화 여부를 조회합니다.

Key versions​

키 버전 생성, 비활성화 및 폐기 예약을 관리합니다.

API설명
Bulk cancel scheduled key version destruction여러 키 버전의 폐기 예약을 일괄 취소합니다.
Bulk schedule key version destruction여러 키 버전의 폐기를 일괄 예약합니다.
Cancel scheduled key version destruction키 버전의 폐기 예약을 취소합니다.
Create key version키 버전을 생성하여 키를 수동 순환합니다.
Deactivate key version키 버전을 비활성화합니다.
List key versionsKMS 키의 버전 목록을 조회합니다.
Schedule key version destruction키 버전의 폐기를 예약합니다.

Keys​

키 조회·생성, 접근 제어와 자동 순환 설정을 관리합니다.

API설명
Add user key access targets키 접근 제어 허용 대상을 추가합니다.
Bulk delete user keys여러 키를 일괄 삭제합니다.
Create user keyKMS 키를 생성합니다.
Delete user keyKMS 키를 삭제합니다.
Get keyKMS 키의 상세 정보를 조회합니다.
Get key by name이름으로 KMS 키의 정보를 조회합니다.
Get public key비대칭 KMS 키의 공개 키를 조회합니다.
List key algorithms키 유형과 용도에 따라 사용할 수 있는 알고리즘 목록을 조회합니다.
List service keys현재 프로젝트의 서비스 키 목록을 조회합니다.
List symmetric keys서비스에서 사용할 수 있는 대칭 암복호화 키 목록을 조회합니다.
List user key access targets키 접근 제어 허용 대상 목록을 조회합니다.
List user keys프로젝트의 KMS 키 목록을 조회합니다.
Remove user key access targets키 접근 제어 허용 대상을 제거합니다.
Update user key access control키 접근 제어 설정을 변경합니다.
Update user key rotation키의 자동 순환 주기를 변경합니다.

Public keys​

데이터 키 생성, 암복호화, HMAC 및 전자 서명 작업을 제공합니다.

API설명
Create data key지정한 KMS 키를 사용하여 데이터 키를 생성합니다.
Decrypt dataKMS 키를 사용하여 데이터를 복호화합니다.
Encrypt dataKMS 키를 사용하여 데이터를 암호화합니다.
Generate HMACKMS 키를 사용하여 HMAC을 생성합니다.
Sign dataKMS 키를 사용하여 데이터에 서명합니다.
Verify HMACKMS 키를 사용하여 HMAC을 검증합니다.
Verify signatureKMS 키를 사용하여 전자 서명을 검증합니다.