API 키

이 플러그인의 설치 단계 및 전체 마크다운 가이드를 포함한 설정 지시를 복사하세요.

API 키는 Capgo API에 대한 인증 요청을 인증하기 위해 사용됩니다. 키는 조직별로 고유하며 RBAC 역할을 Assign하여 세분화된 접근 제어를 할 수 있습니다. 각 키에는 선택적 만료 날짜가 있을 수 있으며, 평문 값이 단 한번만 표시되는 '보안' 키로 생성할 수 있습니다.

API 키를 사용합니다.

API 키를 요청의 헤더에 전달하세요: x-api-key 터미널 창

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

RBAC 권한 authorization header is also accepted but is primarily intended for JWT tokens. When the value is a UUID-formatted API key it works, but x-api-key __CAPGO_KEEP_0__ 키는 사용자 계정과 동일한 역할 기반 접근 제어(RBAC) 시스템을 사용합니다. 웹 앱을 통해 키를 생성하거나 관리할 때, 두 가지 레벨에서 역할을 Assign합니다:

조직 역할

API 키를 요청의 헤더에 전달하세요:

터미널 창 — 조직 전체에서 키의 기본 권한을 정의합니다 (예 org_admin, org_member).
역할 — 앱별 권한 (예 app_admin, app_developer, app_uploader, app_reader).

만약 API 키에 역할 바인딩이 명시적으로 지정되어 있다면 만 해당 바인딩 권한 검사에 평가됩니다. 키 소유자의 개인 권한은 키에 상속되지 않습니다.

조직 생성 권한

Creating organizations with an API key now uses an explicit global permission: org.create.

__CAPGO_KEEP_0__ 키를 사용하여 조직을 생성하는 것은 명시적인 글로벌 권한을 사용합니다. POST /organization/ is called. To create organizations with an API key:

API 키를 사용하여 조직을 생성하려면: org.create __CAPGO_KEEP_0__ 키는 global_permissions.
API 키는 org_admin __CAPGO_KEEP_0__ 키는 org_super_admin __CAPGO_KEEP_0__ 키는
API 키는 org.create __CAPGO_KEEP_0__ 키를 사용하여 조직을 생성하는 것을 허용합니다. __CAPGO_KEEP_0__ 키를 사용하여 조직을 생성하는 것을 허용합니다. When API key을 생성하거나 편집할 때 대시보드에서.
기존에 작성 가능한 org admin/super admin API key이 이미 채워졌습니다. org.create 이러한 existing 통합을 위해 기존 통합이 계속해서 조직을 생성할 수 있습니다.

API key이 조직을 생성할 때, Capgo은 자동으로 API key을 동일한 key로 assign합니다. org_super_admin 새로 생성된 조직에 __CAPGO_KEEP_2__ key을 assign하면, 통합은 생성한 조직을 관리할 수 있습니다. 별도의 수동 역할 바인딩이 필요하지 않습니다.

API key을 API을 통해 생성할 때, org admin 바인딩과 함께 __CAPGO_KEEP_3__을 포함하세요. global_permissions 클립보드 복사

{
  "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 Secure (Hashed) Keys org_super_admin.

Secure key를 생성할 때, 서버는 키 자료를 생성하고 평문 값을 반환합니다. 한 번만 반환합니다. 저장되는 것은 해시만입니다. 이는:

__CAPGO_KEEP_5__

__CAPGO_KEEP_0__은 평문 키입니다. __CAPGO_KEEP_1__를 생성한 후에는 __CAPGO_KEEP_1__을 다시 가져올 수 없습니다. __CAPGO_KEEP_2__을 생성하면 새로운 평문 키(__CAPGO_KEEP_2__)와 저장된 해시를 업데이트하는 것이 가능합니다.
__CAPGO_KEEP_3__ 키는 프로덕션 환경에서 권장되는 키 형식입니다.
일부 조직은 __CAPGO_KEEP_4__ 정책을 통해 해시된 키만 허용합니다.

__CAPGO_KEEP_5__ enforce_hashed_api_keys __CAPGO_KEEP_6__

__CAPGO_KEEP_7__

__CAPGO_KEEP_9__

__CAPGO_KEEP_10__

__CAPGO_KEEP_11__ (require_apikey_expiration — 모든 새로운 키는 만료일을 가지고 있어야 합니다.
최대 유효 시간 (max_apikey_expiration_days — 만료일은 현재로부터 N일 이내여야 합니다.

보안 최적화

최소 권한 원칙: 가능한 한 제한적인 역할을 할 수 있는 한, 통합이 작동할 수 있도록 __CAPGO_KEEP_0__ 역할을 assign하세요.
정기적인 회전: API 키를 regenerate 기능을 사용하여 정기적으로 회전하세요.
안전한 저장: API 키를 안전하게 저장하고 버전 관리에 포함하지 마세요.
해시된 키 사용: 프로덕션 통합을 위한 보안 (해시) 키를 생성하세요
Set Expiration: 임시 또는 CI/CD 액세스에 사용되는 키에 항상 만료일을 설정하세요
Scope Restrictions: 최소 권한의 역할과 함께 특정 앱에 키를 제한하세요

Common Use Cases

: 특정 앱에 키를 제한하고 만료일을 설정하여 CI/CD 통합을 생성하세요or app_uploader Deployment Automation app_developer : CI/CD 통합을 위한 키를 생성하세요
Section titled “Common Use Cases”: __CAPGO_KEEP_0__를 사용하여 app_developer role을 사용하여 자동화된 배포 스크립트
모니터링 도구: __CAPGO_KEEP_0__를 사용하여 app_reader role을 사용하여 외부 모니터링 통합
관리자 접근 권한: __CAPGO_KEEP_0__를 사용하여 org_admin role을 사용하여 관리 도구에
세 번째-party 통합: __CAPGO_KEEP_0__를 사용하여
role을 사용하여 특정 앱에 제한된 액세스조직 제공 사항 org_admin or org_super_admin __CAPGO_KEEP_0__ 키와 org.create 만 신뢰할 수 있는 자동화만이 조직을 만들기 위해 사용할 수 있습니다.

API 키에서 계속하기

__CAPGO_KEEP_0__ 키를 사용 중이라면 API 키 인증 및 계정 흐름을 계획하는 데 사용할 수 있습니다. __CAPGO_KEEP_0__ 키를 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login에 연결하세요. @capgo/capacitor-social-login의 implementation detail에 대한 자세한 내용은 @capgo/capacitor-social-login에서 확인할 수 있습니다. @capgo/capacitor-passkey @capgo/capacitor-passkey의 implementation detail에 대한 자세한 내용은 @capgo/capacitor-passkey에서 확인할 수 있습니다. capgo 키를 사용하여 인증 및 계정 흐름을 계획하는 경우 @capgo/capacitor-social-login을 @capgo/capacitor-passkey과 연결하세요. @capgo/capacitor-native-biometric capgo의 구현 세부 사항에 대한 @capacitor-native-biometric 두 단계 인증 __CAPGO_KEEP_0__의 구현 세부 사항에 대한 두 단계 인증, 그리고 SSO (기업) __CAPGO_KEEP_0__의 구현 세부 사항에 대한 SSO (기업).