컨텐츠로 건너뛰기

API 키

API 키는 역할 기반 접근 제어(RBAC)로 관리됩니다. 각 키는 조직 전체에 역할을 assign하고 optional per-app 역할을 부여하여, 각 키가 접근할 수 있는 것을 fine-grained 제어할 수 있습니다.

API 키는 어디에 관리되나요?

제목 ‘API 키는 어디에 관리되나요?’

이동하여 설정 > 조직 > API 키 at console.capgo.app/settings/organization/api-keys.

페이지는 두 가지 섹션을 표시합니다.

  • RBAC 키 할당된 역할을 가진 키(권장). 이 키는 새로운 역할 기반 권한 시스템을 사용합니다.
  • 레거시 키 — 간단 모드 기반 시스템 (read, upload, write, all)을 사용하는 이전 키.
API 키 목록 페이지 (RBAC 및 Legacy 섹션)

API 키를 새로 생성하는 방법

API 키를 새로 생성하는 방법
  1. 버튼을 클릭하여 RBAC 키 테이블 상단에 위치 ”+” 키 정보

  2. 이름 (필수) — 키에 대한 설명적 레이블 (예: "CI/CD Deploy", "Monitoring Read-Only") 안전한 키 생성:

    • __CAPGO_KEEP_0__ __CAPGO_KEEP_0__
    • __CAPGO_KEEP_0__ (선택 사항) — 체크하면 키가 서버 측에서 해시 처리됩니다. 평문 키는 생성 후 한 번만 표시됩니다. 나중에 다시 가져올 수 없습니다. 한 번만 나중에 다시 가져올 수 없습니다.
    • 만료일 설정 (선택 사항) — 키가 작동하지 않게 할 날짜를 선택하세요. 일부 조직에서는 정책에 따라 필수적으로 만료를 강제합니다.
API 이름, 보안 키 옵션 및 만료일을 가진 API 키 생성 양식
  1. 선택 조직 역할 — 조직 전체에서 키의 기본 권한을 정의합니다. 사용자 역할 수준에 따라 사용 가능한 역할이 다릅니다:

    • 없음 — 조직 전체에 대한 접근 권한이 없으며 키는 개별적으로 할당된 앱에만 접근할 수 있습니다.
    • 멤버 — 기본 읽기 접근 권한이 있는 조직에 대한 접근.
    • 관리자 — 조직에 대한 전체 관리자 접근 권한 (모든 앱에 대한 접근 권한을 상속함).
  2. API에서 조직을 생성해야 하는 경우 키가 필요합니다. API를 통해 공개적으로 조직을 생성하도록 허용합니다. 조직 생성 허용.

    이것은 글로벌 org.create 권한을 추가합니다. 이 키가 관리자 조직 역할을 가지고 있는 경우에만 사용할 수 있습니다. 이 키가 새로운 조직을 생성할 때, Capgo는 자동으로 새로운 조직에 대해 Super Admin으로 키를 Assign합니다.

  3. 관리자 역할이 아닌 경우, __CAPGO_KEEP_0__에 앱별 접근 권한을 추가할 수 있습니다. 클릭:

    • ”+ 앱 추가” 앱 픽커를 열기 위해. __CAPGO_KEEP_0__
    • Select one or more apps, then assign a role to each:
      • 앱을 하나 이상 선택하고 각 앱에 역할을 assign하세요: 앱 리더
      • — 앱에 읽기 전용 접근권한. 앱 업로더
      • — 새로운 배ंडल 업로드 가능. 앱 개발자
      • — 앱 구성 및 배포 관리 가능. 앱 관리자
— 앱에 전체 접근권한.
  1. RBAC 역할 선택: 조직 수준 및 앱별 역할 클릭하세요: "생성".

  2. __CAPGO_KEEP_0__ 키를 생성할 때 “보안 키 생성” 옵션을 체크했다면, 평문 키가 표시되는 모달이 나타납니다. 바로 복사하세요. — 모달을 닫으면 평문 키를 복원할 수 없습니다.

API 키 시크릿 모달(한 번만 사용 가능)

API 키를 편집하는 방법

API 키 편집 방법

__CAPGO_KEEP_0__ 키를 편집하는 방법 __CAPGO_KEEP_0__ 키 편집 방법 __CAPGO_KEEP_0__ 키를 편집하는 방법

  • __CAPGO_KEEP_0__ 키를 편집하는 방법 __CAPGO_KEEP_0__ 키를 편집하는 방법.
  • __CAPGO_KEEP_0__ 키를 편집하는 방법 organization 역할.
  • Enable 또는 disable 조직 만들기 허용 __CAPGO_KEEP_0__ 키가 Admin organization 역할을 가지고 있을 때.
  • Add, remove, 또는 change per-app 역할.

Click “변경 사항 저장” 완료되면.

API 키 편집 페이지에 현재 역할 설정

API 키의 비밀 값이 다시 생성되려면 목록에 있는 키 중 하나의 refresh 아이콘을 클릭하세요. 리스트에 있는 키 중 하나의

(Regenerate) 아이콘을 클릭하세요.

  • 확인 대화상자가 나타납니다. 확인 후: 보안 (해시) 키의 경우: 새 평문 키가 모달에서 한 번만 표시되고 복사하세요.
  • 평문 키의 경우 : 키 값이 서버에서 다시 생성됩니다.기존 키 값이 사용된 모든 통합이 즉시 작동을 멈출 것입니다.

__CAPGO_KEEP_0__ 키 재생성 확인

API key regeneration confirmation

API 키를 삭제하는 방법은?

API 키를 삭제하는 방법

삭제 아이콘 (삭제) 목록 내의 키에 적용 삭제 확인 대화 box에서 삭제를 확인

__CAPGO_KEEP_0__ 키 삭제 확인 대화 box

API key deletion confirmation dialog

기존 키 역할 할당이 없는 키 (Legacy Keys) 섹션에 키가 보인다면, 이러한 키는 이전 모드 기반 권한 시스템을 사용합니다.read, upload, write, allRBAC 권한이 세분화된 기능을 활용하지 않더라도 여전히 작동합니다.

기존 키는 목록에서 다시 생성 및 삭제할 수 있지만 RBAC 역할을 추가하여 편집할 수 없습니다. 가능한 경우 새로운 RBAC 키를 생성하고 기존 키를 삭제하는 것을 추천합니다.

관리가 필요하다면 여전히 다음 위치에서 직접 관리할 수 있습니다. 콘솔에서 capgo 앱/대시보드/API키이 페이지는 deprecated 상태이며 향후 업데이트에서 제거될 예정입니다.

API 키에서 계속

제목: API 키에서 계속

__CAPGO_KEEP_0__ 키를 사용하여 대시보드 및 __CAPGO_KEEP_0__ 작업을 계획하고 있다면, __CAPGO_KEEP_0__ 개요와 연결하세요. API 개요에서 API 개요의 구현 세부 정보를 확인하세요. API 키를 사용하여 대시보드 및 API 작업을 계획하고 있다면, API 개요와 연결하세요. API 개요에서 API 개요의 구현 세부 정보를 확인하세요. API 키를 사용하여 대시보드 및 API 작업을 계획하고 있다면, API 개요와 연결하세요. __CAPGO_KEEP_0__ Introduction API Keys API Keys 구현 세부 정보를 위한 __CAPGO_KEEP_0__ Keys 기기 구현 세부 정보를 위한 기기 패키지