API 키

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

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

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

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

• RBAC 키 — 할당된 역할이 있는 키 (권장). 이 키는 새로운 역할 기반 권한 시스템을 사용합니다.
• 기존 키 — 역할 할당이 없는 단순 모드 기반 시스템 (read, upload, write, all)을 사용하는 오래된 키.

새 API 키를 생성하는 방법

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

2. 키 정보를 입력하세요. 키 정보:

   • 이름 (필수) — 키에 대한 설명적 레이블 (예: "CI/CD Deploy" 또는 "Monitoring Read-Only")
   • 안전한 키 생성 (선택) — 서버 측에서 키를 해시화 할 때, 평문 키는 생성 후 한 번만 표시되고 나중에 복원할 수 없습니다. 만료 날짜 설정 (선택) — 키가 더 이상 작동하지 않도록 날짜를 선택하세요. 일부 조직에서는 정책을 통해 필수 만료 날짜를 강제합니다.
   • __CAPGO_KEEP_0__ __CAPGO_KEEP_0__

3. 권한 범위 선택:

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

4. 키가 API에서 공공으로 조직을 생성해야 한다면, 조직 생성을 허용.

   이것은 글로벌 org.create 권한을 추가합니다. 키는 또한 조직 범위의 org_admin 또는 org_super_admin 바인딩이 필요합니다. 대시보드에서 관리자 를 선택하면 생성됩니다. org_admin 바인딩. 이 키가 새로운 조직을 생성할 때, Capgo은 자동으로 새로운 조직에 이 키를 슈퍼 어드민으로 할당합니다.

5. 앱에 접근 허용하기:

   • 언제 선택한 앱만 사용할 수 있도록 제한 이 옵션이 활성화되면, 선택한 조직 아래에 있는 조직을 선택하여 앱을 표시합니다. 선택한 앱 바인딩은 소유한 조직과 연관이 유지되며, 이 필터는 조직 전체에 대한 접근 권한을 부여하지 않습니다. 클릭 to reveal its apps. The selected app bindings remain associated with their owning organizations; this filter does not grant organization-wide access.
   • + 앱 추가 ”+ Add App”선택한 앱을 하나 이상 선택한 후 각 앱에 역할을 assign합니다.
     • 앱 리더 — 앱에 대한 읽기 전용 접근 권한.
     • 앱 업로드 — 새로운 번들을 업로드할 수 있습니다.
     • 앱 개발자 — 번들을 업로드할 수 있으며, 장치 관리, 네이티브 빌드 트리거링, 채널 설정 업데이트와 같은 기능을 사용할 수 있습니다.
     • 앱 관리자 — 앱에 대한 전체 접근 권한
     • 앱 미리보기 — CI/CD 라이프사이클 미리보기: 번들을 업로드하고 미리보기 채널을 생성합니다. 이 키에 대한 채널 범위 라이프사이클 권한은 자동으로 부여됩니다.

6. 클릭 “Create”.

7. 만약에 보안 키 생성모달에서 평문 키를 복사하세요. 복사하세요 — 모달을 닫으면 복원할 수 없습니다. __CAPGO_KEEP_0__ 키 비밀 모달에 복사 버튼

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

CI가 임시, 비공개 미리보기 채널을 생성하고, 패키지를 업로드하고, 승격하고, 채널과 패키지를 모두 삭제하는 데 사용됩니다. 기존 기본 또는 메인 채널에 대한 라이프사이클 접근 권한이 없습니다. RBAC 키를 생성하고 활성화하세요. 이 키를 선택한 앱에만 제한하세요.

1. 이 키를 선택한 앱에만 제한하세요. Under.
2. for __CAPGO_KEEP_0__선택한 조직의 앱을 필터링합니다.
3. 선택한 조직을 선택하여 앱을 표시합니다; 선택한 각 앱은 소유하는 조직과 연관이 유지됩니다.
4. __CAPGO_KEEP_0__ 보기 앱 미리보기
5. 선택한 각 앱에 대해

CI 비밀 관리자에 안전한 키를 생성하고 만료일을 설정할 때 적절히, 그리고 저장합니다. 이 선택한 앱만 표시하는 모드는 조직 전체 역할을 생략합니다; 조직 연관성을 제거하지는 않습니다. 각 결합은 선택한 앱과 그 앱의 소유하는 조직에 범위가 지정됩니다. app_preview 허용

__CAPGO_KEEP_0__	권한 및 경계
app_preview 선택한 앱에서	app.read, app.read_bundles, app.upload_bundle, 및 app.create_channel.
자동 channel_preview 바인딩	이 키가 채널을 만들 때, Capgo 자동으로 키에 channel.read, channel.promote_bundle, 및 channel.delete 그 채널만을 위한.

app_preview 유지 app.read, 그래서 키는 선택한 앱에서 채널 메타데이터를 열거할 수 있습니다. 자동 자식 바인딩은 경계입니다: 키가 만들지 않은 채널에 대한 라이프 사이클 변형을 부여하지 않습니다. management 경계

Capgo도 앱 미리보기 키가 업로드 한 번들을 기록합니다. 키는 각 미리보기 채널을 생성할 때만 자신의 번들을 설정할 수 있고, 그 pair를 함께 삭제할 수 있습니다. existing 기본 또는 메인 채널, 다른 미리보기 키가 생성한 채널, 또는 다른 키의 번들을 받지 않습니다.

일반적인 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 경로를 사용합니다: 키가 미리보기 채널과 연결된, 공유되지 않은 번들을 소유할 때만 성공합니다. 앱 미리보기 아직 일반적인 bundle.delete아니므로 임의의 번들을 삭제할 수 없습니다.

주의

새로운 비공개 채널을 사용하세요. pr-<number> 채널. 이 workflow에 전달하지 마세요. --default, --self-assign, rollout 옵션, 또는 --delete-linked-bundle-on-upload 이 existing default/main 채널, 다른 미리보기 키의 채널, 또는 다른 키의 배포본을 변경하거나 삭제할 수 없습니다. 앱 바인딩을 취소하거나 만료하는 경우 키의 유효한 라이프 사이클 접근 권한도 제거됩니다. See the Access Control Reference

전체 경계를 위한 __CAPGO_KEEP_0__ 키를 관리(편집)하는 방법은? Section titled “__CAPGO_KEEP_0__ 키를 관리(편집)하는 방법?”

How to manage (edit) an API key?

icon App Preview (관리) 목록 내의 RBAC 키 중에任意 하나를 클릭하여 열 수 있습니다. 이 키 상세 페이지에서 다음을 수행할 수 있습니다.

• 키 이름 변경 이름.
• 키 상세 페이지에서 조직 역할 업데이트.
• 키가 Admin 역할을 가진 조직 역할일 때 조직을 생성할 수 있도록 허용하거나 허용/비허용 키가 Admin 역할을 가진 조직 역할일 때 조직을 생성할 수 있도록 허용합니다.
• 앱별 역할 추가/삭제/변경 앱별 역할.

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

API 키를 다시 생성하는 방법은?

API 키의 비밀 값의 새 버전을 얻으려면 키 목록에서 키를 클릭하여 "새로 고침" 아이콘을 클릭하세요. 리스트 내의 키에서 "(Regenerate)"를 클릭하세요. 확인 대화상자가 나타납니다. 확인 후:

보안 (해시) 키의 경우:

• 새로운 평문 키가 모달에서 한 번만 표시되고, 즉시 복사하세요. 보안 (해시) 키의 경우:새로운 평문 키가 모달에서 한 번만 표시되고, 즉시 복사하세요.
• 보안 (해시) 키의 경우: plain keys: __CAPGO_KEEP_0__ 키는 서버에서 다시 생성됩니다.

이전 키 값을 사용하는 모든 통합은 즉시 작동을 멈출 것입니다.

API 키를 삭제하는 방법

리스트 내의 키 중 하나에 있는 (삭제) 아이콘을 클릭합니다. 확인 대화에서 삭제를 확인합니다.

__CAPGO_KEEP_0__ 키 삭제 확인 대화

Legacy keys

If you see keys in the Legacy Keys Legacy keys는 역할 할당이 없는 키들입니다. 이들은 모드 기반의 권한 시스템 (read, upload, write, all)을 사용합니다. 이들은 여전히 작동하지만 RBAC의 세부 권한에서 이점을 누리지 못합니다.

Legacy keys는 목록에서 다시 생성 및 삭제할 수 있지만 RBAC 역할을 추가하여 편집할 수 없습니다. RBAC 키를 생성하고 가능할 때 Legacy 키를 삭제하는 것을 추천합니다.

Legacy keys를 직접 관리해야 한다면 여전히 console.capgo.app/dashboard/apikeys에 접근할 수 있습니다. 이 페이지는 미래의 업데이트에서 제거될 예정입니다.

Keep going from API Keys

If you are using API 키 계획 대시보드 및 API 운영을 계획하기 위해 연결하세요. API 개요 API 개요의 구현 세부 정보에 대해 소개 소개의 구현 세부 정보에 대해 API 키 API 키의 구현 세부 정보에 대해 장치 장치의 구현 세부 정보에 대해 배포 배포의 구현 세부 정보에 대해