API 키

복사할 수 있는 AI 설정 지시

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

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

__CAPGO_KEEP_0__ 키 관리 위치로 이동하세요. 설정 > 조직 > API 키 __CAPGO_KEEP_1__ 콘솔에서 capgo.app/settings/organization/api-keys.

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

RBAC 키 Assigned 역할을 가지는 키(권장). 이 키는 새로운 역할 기반 권한 시스템을 사용합니다.
기존 키 — 기존 키는 역할 할당이 없는 단순 모드 기반 시스템을 사용하는 키입니다.read, upload, write, all__CAPGO_KEEP_0__ 키 목록 페이지

API 키를 새로 생성하는 방법

버튼을 클릭합니다. ”+” 키 정보
이름 (필수) — 키에 대한 설명적 레이블 (예: "CI/CD Deploy" 또는 "Monitoring Read-Only"):
- __CAPGO_KEEP_0__ __CAPGO_KEEP_0__
- 보안 키 생성 (선택 사항) — 체크하면 키가 서버 측에서 해시됩니다. 평문 키는 생성 후 한 번만 표시되고 나중에 복원할 수 없습니다. 한 번만 표시 생성 후 평문 키를 복원할 수 없습니다.
- 만료 날짜 설정 (선택 사항) — 키가 작동하지 않게 하는 날짜를 선택합니다. 일부 조직에서는 정책에 따라 필수적으로 만료 날짜를 설정합니다.

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

이것은 전역 org.create 권한을 추가합니다. org_admin 또한 키는 조직 범위가 필요합니다. org_super_admin 또는 HTML 텍스트 조각은 더 긴 Capgo UI 문자열 (부모 키 `alternatives_cta_questions`). 페이지/영역: Capacitor live-update 대안 비교 페이지. 역할: 장기 마케팅 또는 법적 문단. 표시: 페이지 alternatives.astro. Capgo 제품/브랜드 및 개발자 용어를 정확하게 유지하십시오. 메시지 키 `alternatives_cta_questions` (대안 CTA 질문). | HTML 텍스트 조각은 더 긴 Capgo UI 문자열 (부모 키 `appflow_cta_questions`). 페이지/영역: Appflow 비교 / 마이그레이션 마케팅 복사본. 역할: 장기 마케팅 또는 법적 문단. 표시: 페이지 ionic-appflow.astro. Capgo 제품/브랜드 및 개발자 용어를 정확하게 유지하십시오. 메시지 키 `appflow_cta_questions` (Appflow CTA 질문). | HTML 텍스트 조각은 더 긴 Capgo UI 문자열 (부모 키 `capwesome_cta_questions`). 페이지/영역: Capawesome 비교 페이지. 역할: 장기 마케팅 또는 법적 문단. 표시: 페이지 capwesome.astro. Capgo 제품/브랜드 및 개발자 용어를 정확하게 유지하십시오. 메시지 키 `capwesome_cta_questions` (Capwesome CTA 질문). | HTML 텍스트 조각은 더 긴 Capgo UI 문자열 (부모 키 `consulting_faq_subtitle`). 페이지/영역: 컨설팅 서비스 페이지. 역할: 섹션 서브 타이틀 또는 태그 라인. 표시: 페이지 consulting.astro. Capgo 제품/브랜드 및 개발자 용어를 정확하게 유지하십시오. 메시지 키 `consulting_faq_subtitle` (컨설팅 FAQ 서브 타이틀). | 페이지/영역: Appflow 비교 / 마이그레이션 마케팅 복사본. 역할: 짧은 UI 레이블 또는 네비게이션 아이템. 표시: 페이지 ionic-appflow.astro, 페이지 ionic-enterprise-plugins.astro, 페이지 solutions/ionic-enterprise-plugins.astro. 메시지 키 `appflow_plugins_or` (Appflow 플러그인 또는). 결합을 추가합니다. 대시보드에서 org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.
관리자
- 결합을 만듭니다. 이 키가 새로운 조직을 만들면 __CAPGO_KEEP_0__ 자동으로 키를 새로운 조직에 Super Admin으로 assignments합니다. 권한 부여: 만약 이 키를 선택한 앱에만 제한합니다. 앱을 드러내려면.
- Click ”+ Add App”앱을 선택하고, 하나 이상의 앱을 선택한 다음 각 앱에 역할을 assign:
  - 앱 리더 — 앱에 대한 읽기 전용 접근 권한.
  - 앱 업로더 — 새로운 배ंडल 업로드가 가능합니다.
  - 앱 개발자 — 배ंडल 업로드, 장치 관리, 네이티브 빌드 트리거, 채널 설정 업데이트 가능.
  - 앱 관리자 — 앱에 대한 전체 접근 권한.
  - 앱 미리보기 — CI/CD 라이프사이클 미리보기: 번들을 업로드하고 미리보기 채널을 생성합니다. 이 키에 대한 채널은 자동으로 채널 범위의 라이프사이클 권한만을 받습니다.
클릭 “생성”.
만약에 안전한 키 생성, 모달이 표시되며 평문 키가 표시됩니다. 즉시 복사하세요 — 모달을 닫으면 복원할 수 없습니다.

One-time API key secret modal with copy button

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

사용 앱 미리보기 CI를 위한 임시 미공개 미리보기 채널을 생성하고 업로드하고 배포하고 채널과 배포를 모두 삭제하는 데 사용됩니다. 기존 기본 또는 메인 채널에 대한 라이프 사이클 액세스가 없습니다.

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

This selected-apps-only mode organization-wide 역할을 생략합니다; it does not remove organization association. 각 app_preview binding은 선택한 앱과 해당 앱의 소유 기관에スコ프드됩니다.

권한 부여 및 경계	선택한 앱에
`app_preview` , 그리고	`app.read`, `app.read_bundles`, `app.upload_bundle`자동 `app.create_channel`.
binding `channel_preview` 이 키가 채널을 생성할 때, __CAPGO_KEEP_0__ 자동으로 키에	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 키에서 (관리) 버튼을 클릭합니다. 이로 인해 키 세부 정보 페이지가 열리며, 여기서 다음을 수정할 수 있습니다:

키 이름 조직 역할 업데이트.
활성화/비활성화 __CAPGO_KEEP_0__ 키를 편집하는 방법.
__CAPGO_KEEP_0__ 키를 편집하는 방법 회사 만들기 허용 키가 관리자 역할을 가진 조직 역할을 할 때
추가, 제거, 또는 변경 앱별 역할.

완료되면 “변경 저장” 클릭 __CAPGO_KEEP_0__ 키 편집 페이지에 현재 역할 설정

API 키 재생성 방법

To regenerate the secret value of an API key, click the 새 값을 얻으려면 (리젠) 목록 내의 키 중 하나를 클릭하세요.

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

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

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

API 키를 삭제하는 방법

리스트 내의 키에 대해 삭제 아이콘을 클릭하세요. 휴지통 아이콘 (삭제) 키 목록 내의 키에 대해 삭제 아이콘을 클릭하세요. 삭제 확인 대화에서 삭제를 확인하세요.

키가 즉시 취소되며, 사용 중인 키로 요청을 보내면 실패합니다.

기존 키

기존 키 섹션 (권한 할당이 없는 키)에서 키를 확인할 수 있습니다. 이 키들은 이전의 모드 기반 권한 시스템을 사용합니다. 기존 키 기존 키 섹션read, upload, write, all기존 키는 권한 할당이 없는 키입니다. 이 키들은 이전의 모드 기반 권한 시스템을 사용합니다.

기존 키는 권한 할당이 없는 키입니다. 권한 할당이 있는 키를 생성하고 기존 키를 삭제하는 것을 권장합니다.

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

API 키로 계속 진행하세요.

이미 __CAPGO_KEEP_0__ 키를 사용 중이라면 API 키 API 키를 사용하여 대시보드 및 API 연산을 계획하고 있다면, API Overview와 연결하세요. API Overview API Overview에서 API Overview에 대한 구현 세부 정보를 참조하세요. 소개 소개에서 구현 세부 정보를 참조하세요. API 키 API 키에 대한 구현 세부 정보 장치 장치에 대한 구현 세부 정보 배포 배포에 대한 구현 세부 정보