API 키

복사할 수 있는 AI 설정 지시

API 키는 역할 기반 접근 제어(RBAC)를 사용합니다. 키는 조직 전체 역할, 앱 범위 바인딩 또는 둘 다를 가질 수 있습니다. 모든 앱 바인딩은 해당 앱의 소유 조직과 연관이 유지됩니다. 최소 권한을 위해, 키를 선택된 앱에 제한하는 대신 조직 전체 역할을 Assign하는 것을 고려하십시오.

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

으로 이동하세요 설정 > 조직 > API 키 위치 console.capgo.app/settings/organization/api-keys.

페이지에는 두 가지 섹션이 있습니다:

RBAC 키 — assigned된 역할을 가진 키(권장). 이 키는 새로운 역할 기반 권한 시스템을 사용합니다.
기존 키 — 이전 버전의 키는 역할 할당이 없는 단순 모드 기반 시스템을 사용합니다.read, upload, write, all__CAPGO_KEEP_0__ 키 목록 페이지는 RBAC 및 Legacy 섹션을 보여줍니다.

API 키를 새로 생성하는 방법

RBAC 키 테이블 위쪽에 있는 ”+” __CAPGO_KEEP_0__ 키 정보
__CAPGO_KEEP_0__ 키 이름 (필수) — 키에 대한 설명적 레이블 (예: "CI/CD Deploy" 또는 "Monitoring Read-Only"):
- __CAPGO_KEEP_0__ __CAPGO_KEEP_0__
- 보안 키 생성 (선택 사항) — 서버 측에서 키를 해시하면 평문 키가 표시됩니다. 평문 키는 생성 후 더 이상 검색할 수 없습니다. 한 번만 만들어집니다.
- 만료 날짜 설정 (선택 사항) — 키가 작동하지 않도록 설정할 날짜를 선택하세요. 일부 조직에서는 정책을 통해 필수 만료를 강제합니다.

키 범위 선택:
- 조직 전체 접근 권한 — 조직 역할을 선택하여 기본 권한을 조직 내에서 정의합니다. 사용 가능한 역할은 자신의 역할 수준에 따라 다릅니다: 조직 역할 을 선택하세요.
  - 없음 — 조직 전체에 대한 접근 권한이 없습니다.
  - 멤버 — 조직에 대한 기본적인 읽기 접근 권한.
  - 관리자 — 조직과 모든 앱에 대한 전체적인 관리 접근 권한.
- 앱 전용 접근 — 활성화 이 키를 선택한 앱에만 제한. 각 앱 바인딩은 해당 앱의 소유 조직과 연결이 유지되며, 이 모드는 조직 전체 RBAC 역할만 생략합니다.
키가 API에서 조직을 생성해야 하는 경우 활성화 조직 생성을 허용.

이것은 전역 org.create 권한을 추가합니다. 키도 조직 범위가 필요합니다. org_admin 또는 org_super_admin 권한을 부여하려면: 이 키가 새로운 조직을 만들 때 __CAPGO_KEEP_0__은 자동으로 키를 새로운 조직에 Super Admin으로 할당합니다. 앱에 접근을 허용하려면: org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.
이 키가 선택한 앱에만 제한되도록 하려면:
- 선택한 앱을 필터링하기 위해 조직을 선택하세요. Admin Admin Admin 앱을 드러내려면.
- Click ”+ Add App”앱을 선택하고, 하나 이상의 앱을 선택한 다음 각 앱에 역할을 assign:
  - 앱 리더 — 앱에 대한 읽기 전용 접근 권한.
  - 앱 업로더 — 새로운 버너를 업로드 할 수 있습니다.
  - 앱 개발자 — 버너를 업로드 할 수 있으며, 장치 관리, 원시 빌드 트리거, 채널 설정 업데이트 할 수 있습니다.
  - 앱 관리자 — 앱에 대한 전체 접근 권한.
  - 앱 미리보기 — CI/CD 라이프사이클 미리보기: 번들을 업로드하고 미리보기 채널을 생성합니다. 이 키에 대한 채널은 자동으로 채널 범위의 라이프사이클 권한만을 받습니다.
클릭 “Create”.
만약에 보안 키 생성, 모달이 표시되며 평문 키가 표시됩니다. 즉시 복사하세요 — 모달을 닫으면 복원할 수 없습니다.

앱 미리보기 키를 사용하여 미리보기 워크플로우

사용 앱 미리보기 CI를 위한 임시 미리보기 채널을 생성하고 업로드, 프로모션, 채널 및 번들을 삭제하는 임시, 비공개 미리보기 채널을 생성하는 데 사용됩니다. 기존 기본 또는 메인 채널에 대한 라이프 사이클 액세스를 갖지 않습니다.

RBAC 키를 생성하고 선택한 앱에만 이 키를 제한.
아래 조직을 필터링하기 위해 앱을 선택, 선택한 조직을 표시하기 위해 조직을 선택; 각 선택한 앱은 소유하는 조직과 연관이 유지됩니다.
미리보기 배포에만 사용되는 앱 또는 앱만 추가
선택 앱 미리보기 각 선택한 앱에 대해
보안 키를 생성하고 적절한 경우 만료 날짜를 설정하고 CI 비밀 관리자에 저장하세요.

이 선택된 앱 전용 모드는 조직 전체 역할을 생략합니다. 그러나 조직 연관성을 제거하지 않습니다. 각 바인딩은 선택한 앱과 해당 앱의 소유 조직에 대한 범위가 지정됩니다. 그렇지 않습니다. 각 app_preview 권한 부여 및 경계

선택한 앱	, 그리고
`app_preview` 자동	`app.read`, `app.read_bundles`, `app.upload_bundle`바인딩 `app.create_channel`.
이 키가 채널을 생성할 때, __CAPGO_KEEP_0__ 자동으로 키에 권한을 부여합니다. `channel_preview` 권한	When this key creates a channel, Capgo automatically gives the key `channel.read`, `channel.promote_bundle`, 그리고 `channel.delete` 해당 채널만을 위해

app_preview 보존합니다 app.read, 따라서 키는 선택된 앱의 채널 메타데이터를 열거할 수 있습니다. 자동 자식 바인딩은 키가 생성하지 않은 채널에 대해 생명 주기 변화를 부여하지 않습니다. 관리 경계: 채널 키가 생성하지 않은 채널에 대해 생명 주기 변화를 부여하지 않습니다.

Capgo은 또한 App Preview 키가 업로드 한 번들을 기록합니다. 키는 각 프리뷰 채널을 생성할 때만 자신의 번들을 설정할 수 있으며, 그 pair를 함께 삭제할 수 있습니다. 기존 기본 또는 메인 채널, 다른 프리뷰 키가 생성한 채널, 또는 다른 키의 번들을 받지 않습니다.

CI 작업의 일반적인 경우, pull request당 유니크한 채널 이름을 사용하세요:

APP_ID="com.example.app"
PREVIEW_CHANNEL="pr-123"
BUNDLE_VERSION="1.2.3-pr.123"

npx @capgo/cli@latest bundle upload "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --path ./dist \
  --channel "$PREVIEW_CHANNEL" \
  --bundle "$BUNDLE_VERSION"

npx @capgo/cli@latest channel delete "$PREVIEW_CHANNEL" "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --delete-bundle \
  --success-if-not-found

새 채널을 만들 때 bundle upload --channel 채널을 생성하고 번들을 업로드한 후 한 번의 흐름으로 승격합니다. 마지막 명령은 좁은 원자적 청소 경로를 사용합니다: 키가 프리뷰 채널과 연결된, 공유되지 않은 번들을 소유할 때만 성공합니다. 애플리케이션 미리보기 일반적인 기능을 지원하지 않기 때문에 bundle.delete이러한 기능을 사용할 수 없습니다.

__CAPGO_KEEP_0__ 권한 제어 참조 전체 경계를 위해

API 키를 편집하는 방법은 어떻게 하나요?

리스트 내의 RBAC 키 중 하나에 있는 수정기호 (관리) 버튼을 클릭합니다. 이 버튼을 클릭하면 키 세부 정보 페이지가 열리고, 여기서 키를 편집할 수 있습니다.

키 이름을 변경합니다. 조직 역할을 업데이트 합니다..
활성화/비활성화 활성화/비활성화.
키 세부 정보 페이지 회사 만들기 허용 키가 관리자 역할을 가진 조직 역할을 가지고 있을 때
추가, 제거 또는 변경 앱별 역할.

클릭 “Save Changes” 완료되면.

API 키 재생성 방법

API 키의 비밀 값의 재생성을 위해, 새로고침 아이콘 클릭 (리젠) 목록 내의 키 중에 어떤 키라도 클릭하세요.

확인 대화창이 나타납니다. 확인 후:

위 보안 (해시) 키: 새로고침 모달에서 한 번만 표시되는 평문 키가 생성되고 표시됩니다. 즉시 복사하세요.
위 평문 키: 서버 측에서 키 값을 다시 생성합니다.

이전 키 값을 사용하는 모든 통합이 즉시 작동을 멈추게 됩니다.

API 키를 삭제하는 방법

리스트 내의 키에 대해 삭제 아이콘을 클릭하세요. 쓰레기통 아이콘 (삭제) 키 목록 내의 키에 대해 삭제 아이콘을 클릭하세요.

확인 대화에서 삭제를 확인하세요.

기존 키

기존 키 섹션 (권한 할당이 없는 키)에서 키를 보게 되면, 이들은 이전의 모드 기반 권한 시스템을 사용하는 것입니다. 기존 키 Legacy Keysread, upload, write, all기존 키는 여전히 작동하지만 RBAC의 세부 권한을 받을 수 없습니다.

기존 키는 새로 생성한 RBAC 키를 만들고 기존 키를 삭제하는 것을 권장합니다.

관리할 필요가 있는 이전 키를 직접 관리해야 하는 경우, 여전히 __CAPGO_KEEP_0__에서 액세스할 수 있습니다. capgo.app/dashboard/apikeys이 페이지는 deprecated되었으며 향후 업데이트에서 제거될 것입니다.

API 키로 계속 진행하세요.

__CAPGO_KEEP_0__ 키를 사용하여 대시보드와 __CAPGO_KEEP_0__ 작업을 계획하고 있습니다. API 키를 사용하여 대시보드와 API 작업을 계획하고 있습니다. API 키를 사용하여 대시보드와 API 작업을 계획하고 있습니다. API Overview API Overview 설명 설명 API 키 API 키 구현 세부 사항에 대한 기기 __CAPGO_KEEP_0__ 키 구현 세부 사항, 기기 및 블록 __CAPGO_KEEP_0__ 키 구현 세부 사항에 대한