API 키

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

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

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

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

• RBAC 키 — 할당된 역할이 있는 키(권장). 이 키는 새로운 역할 기반 권한 시스템을 사용합니다.
• Legacy 키 — 이전 버전의 키는 역할 할당이 없는 단순 모드 기반 시스템 (read, upload, write, allwithout role assignments.

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

1. 페이지 상단의 RBAC 키 테이블에서 ”+” 버튼을 클릭합니다.

2. RBAC 키 테이블 상단의 키 정보:

   • 이름 (필수) — 키에 대한 설명적 레이블 (예: "CI/CD Deploy" 또는 "Monitoring Read-Only")
   • secure key를 생성합니다. (선택 사항) — 서버 측에서 키를 해시할 때 체크합니다. 평문 키는 생성 후 한 번만 표시되고 나중에 다시 가져올 수 없습니다. 한 번만 생성 후 평문 키는 다시 가져올 수 없습니다.
   • 만료일 설정 (선택 사항) — 키가 작동하지 않게 하는 날짜를 선택하세요. 일부 조직에서는 정책을 통해 필수적으로 만료를 강제합니다.

3. 키 범위 선택:

   • 조직 전체 접근 권한 — 조직 역할을 선택하여 조직 내 기본 권한을 정의합니다. 사용자 역할 수준에 따라 사용 가능한 역할이 달라집니다: 없음 __CAPGO_KEEP_0__
     • __CAPGO_KEEP_0__ — 조직 전체에 대한 접근 권한이 없습니다.
     • 회원 — 조직에 대한 기본적인 읽기 접근 권한.
     • 관리자 — 조직과 모든 앱에 대한 전체적인 관리 접근 권한.
   • 앱 전용 접근 — 활성화 선택한 앱에만 이 키를 제한. 각 앱 바인딩은 해당 앱의 소유 조직과 연결이 유지되며, 이 모드는 조직 전체 RBAC 역할만 생략합니다.

4. 키가 API의 공개 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.

5. 만약

   • 이 키를 선택한 앱에만 허용하도록 설정하면 조직을 선택하여 앱을 필터링합니다. 앱을 필터링할 조직을 선택하여 앱을 표시합니다. 선택한 앱 바인딩은 소유한 조직과 연관이 유지되며, 이 필터는 조직 전체에 대한 접근 허용을 제공하지 않습니다. or binding. In the dashboard, selecting
   • 클릭 앱 추가앱을 선택하고 각 앱에 역할을 assign하세요:
     • 앱 리더 — 앱에 읽기 전용 접근권한이 있습니다.
     • 앱 업로더 — 새로운 배ंडल 업로드가 가능합니다.
     • 앱 개발자 — 배ंडल 업로드, 장치 관리, 네이티브 빌드 트리거, 채널 설정 업데이트 가능합니다.
     • 앱 관리자 — 앱에 전체 접근권한이 있습니다.
     • 앱 프리뷰 CI/CD 라이프사이클을 미리보기: __CAPGO_KEEP_0__을 업로드하고 미리보기 채널을 생성합니다. 이 키에 대한 채널은 자동으로 채널 범위의 라이프사이클 권한만을 받습니다.

6. 클릭 ‘생성’.

7. 만약에 체크 안전한 키 생성, 모달이 표시되며 평문 키가 표시됩니다. 즉시 복사하십시오 모달을 닫으면 __CAPGO_KEEP_0__ 키 비밀번호를 다시 찾을 수 없습니다.

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

사용 앱 미리보기 CI가 임시, 비공개 미리보기 채널을 생성하고 업로드, 승격한 다음 채널과 번들을 모두 삭제합니다. 이 기능은 기존 기본 또는 메인 채널에 대한 라이프사이클 접근 권한이 없습니다.

1. RBAC 키를 생성하고 활성화하세요 이 키를 선택한 앱만 제한하세요.
2. 아래 조직을 필터링하기 위해 조직을 선택하세요; 선택한 각 앱은 소유하는 조직과 연관이 유지됩니다.미리보기 배포를 위해 사용하는 앱만 추가하세요.
3. 선택하세요
4. 앱 미리보기 각 선택한 앱에 대해 앱 미리보기
5. CI secret manager에 안전한 키를 생성하고 만료일을 설정하고 저장하세요.

이 선택한 앱 전용 모드는 조직 전체 역할을 생략합니다; 그것은 조직 연관성을 제거하지 않습니다. app_preview 각

결속은 선택한 앱과 그 앱의 소유 조직에 대한 범위로 유지됩니다.	허용
app_preview 권한 및 경계	app.read, app.read_bundles, app.upload_bundle선택한 앱 app.create_channel.
, 그리고 channel_preview 자동	When this key creates a channel, Capgo automatically gives the key channel.read, channel.promote_bundle이 키가 채널을 만들 때, __CAPGO_KEEP_0__ 자동으로 키에 권한을 부여합니다, 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 채널을 생성하고 번들을 업로드하고, 한 번의 흐름에서 이를 승격합니다. 마지막 명령은 narrow atomic cleanup 경로를 사용하여 succeeds: 키가 프리뷰 채널과 그에 연결된, 공유되지 않은 번들을 소유할 때만. 앱 프리뷰 아직 일반적인 __CAPGO_KEEP_0__을 가지고 있지 않습니다. bundle.delete따라서 임의의 __CAPGO_KEEP_0__을 삭제할 수 없습니다.

주의

새로운 비공개 __CAPGO_KEEP_0__을 사용하세요. __CAPGO_KEEP_0__에 pr-<number> __CAPGO_KEEP_0__ 옵션, 또는 --default, --self-assign__CAPGO_KEEP_0__에 전달하지 마십시오. __CAPGO_KEEP_0__는 --delete-linked-bundle-on-upload __CAPGO_KEEP_0__를 승격, 삭제, 또는 변경할 수 없습니다. __CAPGO_KEEP_0__의 기본/주 __CAPGO_KEEP_0__, 다른 미리보기 __CAPGO_KEEP_0__의 __CAPGO_KEEP_0__, 또는 다른 __CAPGO_KEEP_0__의 __CAPGO_KEEP_0__. __CAPGO_KEEP_0__의 앱 바인딩을 취소하거나 만료하면 __CAPGO_KEEP_0__의 유효한 라이프사이클 접근 권한이 제거됩니다.

참조 액세스 제어 참조 전체 경계를 위해 전체를.

API 키를 편집하는 방법은?

목록 내의 RBAC 키 중 하나에 있는 구동기 목록 내의 RBAC 키 중 하나에 있는

• 구동기 목록 내의 RBAC 키 중 하나에 있는 .
• 목록 내의 RBAC 키 중 하나에 있는 목록 내의 RBAC 키 중 하나에 있는 .
• 목록 내의 RBAC 키 중 하나에 있는 목록 내의 RBAC 키 중 하나에 있는 관리자 역할이 있는 키가 있을 때.
• 추가, 제거 또는 변경 앱별 역할.

클릭 “Save Changes” __CAPGO_KEEP_0__ 키 편집 페이지에 현재 역할 설정

API 키 재생성 방법

To regenerate the secret value of an API key, click the (재생성) 버튼 (재생성)

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

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

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

API 키를 삭제하는 방법

버튼 휴지통 아이콘 (삭제) 목록 내의 키에 적용됩니다. 삭제를 확인하려면 대화창에서 확인하세요.

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

기존 키

기존 키가 보인다면, 역할 할당이 없는 키가 사용되고 있습니다. 이들은 이전의 모드 기반 권한 시스템을 사용합니다. 기존 키 기존 키 섹션read, upload, write, all기존 키는 역할 할당을 추가할 수 없습니다. 새로운 RBAC 키를 생성하고 기존 키를 삭제하는 것을 추천합니다.

기존 키를 직접 관리해야 한다면, 여전히 목록에서 재생성하고 삭제할 수 있습니다. 그러나 기존 키를 삭제할 수는 없습니다.

기존 키를 관리하려면 여전히 콘솔.capgo.app/대시보드/API키이 페이지는 deprecated 상태이며 향후 업데이트에서 제거될 예정입니다.

API 키에서 계속 진행하세요

Capacitor를 사용하는 경우 API 키 API 키를 사용하여 대시보드와 API 작업을 계획하고 싶은 경우, API 키를 API Overview와 연결하세요 API Overview API Overview에서 API 키의 구현 세부 사항을 확인하세요 소개 소개에서 구현 세부 사항을 확인하세요 API 키 구현 세부 사항에 대한 API 키에 대해 기기 구현 세부 사항에 대한 기기, 및 묶음 구현 세부 사항에 대한 묶음에 대해