API 키

설치

API 키는 Capgo API로 요청을 인증하기 위해 사용됩니다. 키는 조직별로 지정되어 RBAC 역할을 할당하여 세부적인 접근 제어를 할 수 있습니다. 각 키에는 옵션으로 만료 날짜가 있을 수 있으며, 평문 값이 한번만 표시되는 '보안' 키로 생성할 수 있습니다.

API 키 사용

API 키를 사용하는 경우 인증 헤더를 문서화된 엔드포인트에 따라 사용하십시오. API-키 요청에 대해 authorization 허용됩니다:

curl -H "authorization: YOUR_API_KEY" https://api.capgo.app/...

Channels __CAPGO_KEEP_0__ API 키는 __CAPGO_KEEP_1__ __CAPGO_KEEP_2__로 요청을 인증하기 위해 사용됩니다. 키는 조직별로 지정되어 RBAC 역할을 할당하여 세부적인 접근 제어를 할 수 있습니다. 각 키에는 옵션으로 만료 날짜가 있을 수 있으며, 평문 값이 한번만 표시되는 '보안' 키로 생성할 수 있습니다. 받아 들입니다 authorization 또는 capgkeyLive Update

Cloudflare

API keys use the same role-based access control (RBAC) system as user accounts. When creating or managing keys through the web app or API, you assign roles at two levels:

code API org_admin 또는 org_member).
SDK CLI app_admin, app_developer, app_uploader, app_readernpm app_preview).

만약 API 키가 명시적인 역할 바인딩을 가지고 있다면 바인딩된 역할만 권한 검사에 평가된다. 키 소유자의 개인 권한은 키에 의해 상속되지 않는다.

미리보기 채널 자동화

바인딩 app_preview CI가 임시 미리보기 채널을 생성하고, 업로드하고, 승격하고, 삭제하는 데 사용되는 미리보기 앱에만 바인딩한다.

{
  "name": "PR preview key",
  "hashed": true,
  "bindings": [
    {
      "role_name": "app_preview",
      "scope_type": "app",
      "org_id": "<OWNING_ORG_UUID>",
      "app_id": "<APP_UUID>"
    }
  ]
}

org_id 앱 소유 기관의 UUID입니다. app_id 앱 기록의 내부 UUID는 CLI 명령어에서 사용하는 공개 앱 식별자와 다릅니다. com.example.app은 앱 레코드의 내부 UUID이다. __CAPGO_KEEP_0__ 명령어 (예를 들어, )에 의해 사용되는 공개 앱 식별자와는 다르다.

바인딩은 키가 조직 내 역할을 가지고 있지 않아도 조직에 묶여 있다. app_preview 역할에는만 app.read, app.read_bundles, app.upload_bundle, 그리고 app.create_channel. Capgo이 새로운 채널을 만들 때 자동으로 채널에 바인딩을 추가합니다. 이 자식 바인딩은 채널을 만든 키만이 채널에 대한 접근 권한을 부여합니다. channel_preview 유지합니다 channel.read, channel.promote_bundle, 그리고 channel.delete channel에 생성된 키는 해당 채널만을 위한 것입니다.

app_preview retains app.read사용하지 마십시오 라이프사이클 변형 채널에 생성된 키를 연결합니다.

Capgo records the App Preview key that uploaded each bundle. The key can promote only its own bundle to each preview channel it creates. It has no channel lifecycle access to an existing default/main channel, a channel created by another preview key, or another key’s bundle. For this workflow, omit public never 사용하지 마세요 --default.

사용 channel delete <preview-channel> <public-app-id> --delete-bundle 청소에 사용하세요. 이 경로는 소유권 확인을 통해 원자성에 따라 미리보기 청소 경로입니다. 이 경로는 호출 키의 미리보기 채널과 연결된 번들을 제거합니다. app_preview 일반적인 권한을 부여하지 않습니다. bundle.delete.

대시보드 설정과 완전한 CLI 예제를 보려면 미리보기 워크플로우에 App 미리보기 키를 사용하세요.

조직 생성 권한

API org.create.

__CAPGO_KEEP_0__ POST /organization/ API

API org.create in global_permissions.
API org_admin or org_super_admin __CAPGO_KEEP_0__
API org.create __CAPGO_KEEP_0__ __CAPGO_KEEP_0__ API
기존 write-capable org admin/super admin API 키가 백필드되었습니다. org.create 이러한 기존 통합을 위해 기존 통합이 조직을 생성할 수 있습니다.

API 키가 조직을 생성할 때, Capgo은 자동으로 동일한 API 키를 조직에 할당합니다. org_super_admin 이러한 통합은 생성한 조직을 관리할 수 있도록 허용합니다. 조직을 생성한 후 별도의 수동 역할 바인딩이 필요하지 않습니다.

API 키를 API을 통해 생성할 경우, 조직 관리자 바인딩과 함께 포함되어야 합니다. global_permissions Clipboard 복사

{
  "name": "Provisioning key",
  "hashed": true,
  "bindings": [
    {
      "role_name": "org_admin",
      "scope_type": "org",
      "org_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "global_permissions": ["org.create"]
}

org.create 조직을 생성하는 경우에만 적용됩니다. 조직을 삭제하는 경우에는 일반적으로 삭제 권한이 있는 조직에 대한 삭제 권한이 필요합니다. org_super_admin.

Secure (Hashed) Keys

보안 키를 생성할 때, 서버는 키 자료를 생성하고 평문 키 값을 반환합니다. 평문 키는 한 번만 반환되며, 이후에는 해시만 저장됩니다. 이는 다음과 같은 의미를 갖습니다.

평문 키 얻을 수 없습니다. 생성 후.
새로운 평문 키가 생성되고 저장된 해시가 업데이트됩니다.
생산 환경에서 해시된 키가 권장됩니다.

some organizations는 해시된 키를 org policy를 통해 강제합니다. enforce_hashed_api_keys 만료

Expiration

필수 만료

모든 새로운 키는 만료일이 있어야 합니다.

모든 새로운 키는 만료일이 있어야 합니다. (require_apikey_expiration만료일이 있는 키는 허용 체크層에서 거부됩니다.
최대 유효 시간 (max_apikey_expiration_days) — 현재로부터 N일 이상의 유효 시간은 설정할 수 없습니다.

보안 최선의 관행

최소 권한 원칙: 가능한 한 제한적인 역할을 할당하여 통합이 작동할 수 있도록 하십시오.
정기적인 회전: API 키를 정기적으로 갱신하여 갱신 기능을 사용하여 키를 갱신하십시오.
안전한 저장: API 키를 안전하게 저장하고 버전 관리에 포함시키지 마십시오.
해시된 키 사용: 프로덕션 통합에 대한 안전한 (해시된) 키를 생성하십시오.
만료 설정: 임시 또는 CI/CD 액세스에 사용되는 키에 항상 만료 날짜를 설정합니다.
범위 제한: 최소 권한의 역할을 가진 특정 앱에 키를 제한합니다.

일반적인 사용 사례

CI/CD 통합: 특정 앱에 키를 제한하고 만료 날짜를 설정하여 app_uploader 또는 app_developer 역할, 그리고 만료 날짜를 설정합니다.
PR 미리보기 채널: 사용 app_preview CI에서 빌드할 때 preview 앱 또는 앱에서만 업로드할 수 있는 채널과 번들을 생성하고, 채널과 번들을 원자적으로 삭제합니다.
배포 자동화: CI에서 자동화된 배포 스크립트를 위한 키를 사용하세요. app_developer 모니터링 도구
: 외부 모니터링 통합을 위한 키를 생성하세요.관리자 접근 app_reader 관리자 도구를 사용할 때는 적극적으로 사용하지 마세요.
세 번째 통합: CI에서 자동화된 배포 스크립트를 위한 키를 사용하세요. org_admin : 특정 앱에 제한된 키를 생성하고, 필요한 역할만 부여하세요.
CI에서 빌드할 때 preview 앱 또는 앱에서만 업로드할 수 있는 채널과 번들을 생성하고, 채널과 번들을 원자적으로 삭제합니다.배포 자동화
조직 프로비저닝: 사용하는 org_admin 또는 org_super_admin RBAC 키는 org.create 만 신뢰할 수 있는 자동화에만 조직을 만들기 위해 필요합니다.

API 키에서 계속

__CAPGO_KEEP_0__ 키를 __CAPGO_KEEP_1__-social-login과 연결합니다. API 키 __CAPGO_KEEP_0__ 키에서 계속 @capgo/capacitor-social-login for the @capgo/capacitor-social-login implementation detail @capgo/capacitor-passkey capgo/capacitor-passkey 구현 세부 사항을 위한 @capgo/capacitor-native-biometric for capgo의 구현 세부 정보에 대해 @capacitor-native-biometric, 두 요인 인증 Live Update Single Sign-On (기업) Live Update