API 키

API 키는 역할 기반 접근 제어(RBAC)와 함께 조직 수준에서 관리됩니다. 각 키는 조직 전체 역할과 선택적 앱별 역할을 할당할 수 있어, 각 키가 접근할 수 있는 것을 세세하게 제어할 수 있습니다.

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

Navigate to API 설정 > API > API 키 at console.capgo.app/settings/organization/api-keys.

The page displays two sections:

• __CAPGO_KEEP_0__ 키 — 권한이 assign된 키 (권장). 이 키는 새로운 역할 기반 권한 시스템을 사용합니다.
• __CAPGO_KEEP_0__ 키 — 이전에 사용된 키가 있습니다. 이 키는 역할 assign이 없는 단순 모드 기반 시스템 (read, upload, write, all)을 사용합니다.

API 키를 새로 생성하는 방법?

1. 위의 RBAC 키 테이블에서 ”+” 버튼을 클릭하세요.

2. 키 정보를 Key information:

   • 이름 (필수) — 키에 대한 설명적인 레이블 (예: "CI/CD Deploy", "Monitoring Read-Only")
   • __CAPGO_KEEP_0__ 키를 안전하게 만들기 (선택) — 체크하면 키가 서버측에서 해시 처리됩니다. 평문 키는 생성 후 한번만 표시됩니다. 나중에 키를 복원할 수 없습니다. 만료일 설정 (optional) — When checked, the key will be hashed server-side. The plain-text key is shown only once after creation. You will not be able to retrieve it later.
   • Click the button at the top of the RBAC keys table. (선택 사항) — 키가 작동하지 않도록 하는 날짜를 선택하세요. 일부 조직에서는 정책을 통해 필수적으로 만료되도록 강제합니다.

3. Select an Organization 역할 — 이 정의는 키의 기본 권한을 조직 전체에 걸쳐 정의합니다. 사용자 역할 수준에 따라 사용 가능한 역할이 다를 수 있습니다.

   • 없음 — 조직 전체에 대한 접근 권한이 없습니다. 키는 개별적으로 assign된 앱에만 접근할 수 있습니다.
   • 멤버 — 조직에 대한 기본적인 읽기 접근 권한이 있습니다.
   • 관리자 — 조직 전체에 대한 전체적인 관리 접근 권한이 있으며 모든 앱에 대한 접근 권한을 상속합니다.

4. 만약 키가 API를 통해 조직을 생성해야 한다면, 사용하십시오. 조직 만들기 허용.

   이 기능은 글로벌 org.create 권한을 추가합니다. 이 키가 Admin 역할을 가진 조직 역할을 가지고 있는 경우에만 사용할 수 있습니다. 이 키가 새로운 조직을 만들면 Capgo은 자동으로 새로운 조직에 Super Admin으로 키를 Assign합니다.

5. Admin이 아닌 선택한 org 역할이면 per-app 접근 허용:

   • Click ”+ App 추가” 을 클릭하여 앱 선택기를 열 수 있습니다.
   • 선택한 앱을 하나 이상 선택한 후 각 앱에 역할 assign합니다.
     • 앱 리더 — 앱에 읽기 전용 접근 허용합니다.
     • 앱 업로더 — 새로운 배포를 업로드할 수 있습니다.
     • 앱 개발자 — 앱 구성 및 배포를 관리할 수 있습니다.
     • 앱 관리자 — 앱에 대한 전체 접근 권한.

6. 클릭 ‘생성’.

7. ‘Create secure key’를 체크했다면, 평문 키가 표시되는 모달이 나타납니다. 복사하십시오. (모달이 닫히면 복사할 수 없습니다.) __CAPGO_KEEP_0__ 키 비밀을 복사할 수 있는 모달입니다.

How to manage (edit) an API key?

Click the 도구 모양 아이콘 (Manage) on any RBAC key in the list. This opens the key detail page where you can:

• 키를 편집하여: 키 이름을 변경합니다..
• 조직 역할을 업데이트 합니다. 관리자 역할이 있는 키의 경우 조직을 생성할 수 있습니다..
• Allow creating organizations when the key has an Admin organization role. __CAPGO_KEEP_0__ 키가 관리자 역할을 할 경우 조직을 생성할 수 있습니다. __CAPGO_KEEP_0__ 키를 편집하여 조직을 생성할 수 있습니다.
• __CAPGO_KEEP_0__ 애플리케이션별 역할 추가, 제거, 변경.

클릭 “변경 사항 저장” 완료되었습니다.

API 키의 비밀 값을 다시 생성하는 방법은?

API 키의 비밀 값을 다시 생성하려면 목록 내의 키에 있는 새로 고침 아이콘 (새로 고침) 버튼을 클릭합니다.

확인 대화상자가 나타납니다. 확인 후:

• __CAPGO_KEEP_0__ secure (hashed) keys새로운 평문 키가 모달에서 한번만 표시되고 복사하십시오.
• plain keys 서버에서 키 값을 다시 생성합니다.즉시 작동을 멈추게 됩니다.

__CAPGO_KEEP_0__ 키 재생성 확인

API 키를 삭제하는 방법

For secure (hashed) keys For plain keys (Delete) 키를 목록의任意 키에서 삭제합니다. 삭제 확인 dialog에서 삭제를 확인합니다.

키는 즉시 취소되며, 이 키를 사용하는 요청은 실패합니다.

기존 키

section (역할 할당이 없는 키)에서 키를 보게 되면, 이들은 모드 기반 권한 시스템 ( )을 사용하는 오래된 시스템입니다. 여전히 작동하지만 RBAC의 세부 권한은 받지 못합니다. 기존 키는 목록에서 재생성 및 삭제할 수 있지만 RBAC 역할을 추가하는 것을 편집할 수 없습니다. 가능한 경우 새로운 RBAC 키를 생성하고 기존 키를 삭제하는 것을 추천합니다.read, upload, write, all기존 키를 직접 관리해야 한다면, 여전히

console.__CAPGO_KEEP_0__.app/dashboard/apikeys

에서 접근할 수 있습니다. console.capgo.app/dashboard/apikeys이 페이지는 deprecated 상태이며 향후 업데이트에서 제거될 예정입니다.

API 키를 계속 사용하세요.

__CAPGO_KEEP_0__ 키를 사용 중이라면 API 키를 사용하여 대시보드와 API 작업을 계획하고자 한다면 API 키를 사용하여 대시보드와 API 작업을 계획하고자 한다면, API 개요와 연결하세요. API 개요를 사용하여 API 개요의 구현 세부 정보를 확인하세요. API 개요를 사용하여 구현 세부 정보를 확인하세요. __CAPGO_KEEP_0__ 개요를 사용하여 구현 세부 정보를 확인하세요. __CAPGO_KEEP_0__ 키를 사용하여 구현 세부 정보를 확인하세요. API 키를 사용하여 구현 세부 정보를 확인하세요. API 키를 사용하여 구현 세부 정보를 확인하세요. 기기 기기 구현 세부 정보에 대해 패키지 패키지 구현 세부 정보에 대해