API 키

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

API 키는 Capgo API에 대한 인증 요청을 인증하기 위해 사용됩니다. 키는 조직에 따라 할당할 수 있으며 RBAC 역할을 할당하여 세분화된 접근 제어를 제공할 수 있습니다. 각 키에는 선택적 유효 기간이 있을 수 있으며 평문 값이 단 한 번만 표시되는

API 키를 사용하는 방법

API 키를 요청 헤더에 전달하세요. x-api-key 모든 요청의 헤더에 __CAPGO_KEEP_0__ 키를 전달하세요:

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

헤더는 또한 JWT 토큰에 사용되지만 __CAPGO_KEEP_0__ 키의 UUID 형식일 때만 작동합니다. 모든 키 유형(secure/hashed 키 포함)에서 권장되는 헤더입니다. 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 역할 기반 접근 제어(RBAC) 권한

__CAPGO_KEEP_0__ 키는 사용자 계정과 동일한 역할 기반 접근 제어(RBAC) 시스템을 사용합니다. 웹 앱을 통해 키를 생성하거나 관리할 때, 두 가지 레벨에서 역할을 assign합니다.

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

Organization 역할 — 전체 조직에서 키의 기본 권한을 정의합니다 (예: org_admin, org_member).
App 역할 — 옵션의 앱 권한 (예: app_admin, app_developer, app_uploader, app_reader).

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

단체 생성 권한

현재 API 키를 사용하여 조직을 생성하는 것은 명시적인 글로벌 권한을 사용합니다: org.create.

이 권한은 일반적인 org/app 역할 바인딩과 분리된 것입니다. 조직이 아직 존재하지 않기 때문입니다. __CAPGO_KEEP_0__ 키를 사용하여 조직을 생성하려면: POST /organization/ API 키는

The API key must include org.create __CAPGO_KEEP_0__ 키도 현재 조직 범위의 global_permissions.
The same API key must also have a current organization-scoped org_admin 바인딩이 있어야 합니다. org_super_admin 새로운 __CAPGO_KEEP_0__ 키는 기본적으로
을 받지 않습니다. API 키를 사용하여 조직을 생성하려면 org.create 권한을 활성화해야 합니다. 조직 만들기 허용 대시보드에서 RBAC API 키를 만들거나 편집할 때 API 키를 만들거나 편집할 때
기존에 쓰기 가능한 조직 관리자/슈퍼 관리자 API 키가 org.create 기존 통합이 조직을 계속 만들 수 있도록 하기 위해 기존 통합에 __CAPGO_KEEP_0__ 키를 백업했습니다.

API 키가 조직을 만들면 Capgo이 자동으로 새로 생성된 조직에 API 키를 assign합니다. org_super_admin __CAPGO_KEEP_1__에서 __CAPGO_KEEP_0__ 키를 만들 때, org admin binding과 함께

If you create an API key through the API, include 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 (Hashed) Keys

보안 키를 생성할 때 서버는 키 자료를 생성하고 평문 값을 한 번만 반환합니다. 이 경우에만 해시만 저장됩니다. 이것은 다음과 같은 의미입니다:

__CAPGO_KEEP_0__ 평문 키 생성 후 평문 키를 다시 가져올 수 없습니다.
재생성은 새로운 평문 키(한 번만 표시)를 생성하고 저장된 해시를 업데이트합니다.
제품 환경에서 해시된 키 사용이 권장됩니다.

일부 조직은 org 정책을 통해 해시된 키를 강제합니다. enforce_hashed_api_keys 만료

만료 섹션

조직 정책은 다음과 같이 강제할 수 있습니다:

Some organizations enforce hashed keys via the org policy.

필수 만료 (require_apikey_expiration) — 모든 새로운 키는 만료일을 가져야 합니다.
최대 TTL (max_apikey_expiration_days) — 만료일은 현재 날짜부터 N일 이내여야 합니다.

보안 최적화

최소 권한 원칙: 최소한의 권한을 부여하여도 통합이 작동하는 경우에만 가장 제한적인 역할을 부여하십시오.
정기적인 회전: API 키를 정기적으로 회전하기 위해 재생성 기능을 사용하십시오.
안전한 저장: API 키를 안전하게 저장하고 버전 관리에 포함시키지 마십시오.
__CAPGO_KEEP_0__:
: :
: ,

:

: : app_uploader : app_developer :
배포 자동화: __CAPGO_KEEP_0__ 키와 함께 사용하세요. app_developer 자동화 배포 스크립트의 역할
모니터링 도구: __CAPGO_KEEP_0__ 키와 함께 생성하세요. app_reader 외부 모니터링 통합의 역할
관리자 접근: __CAPGO_KEEP_0__ 키와 함께 사용하세요. org_admin 관리자 도구의 역할
세 번째-party 통합: __CAPGO_KEEP_0__ 키를 제한된 앱에만 사용하고 최소한의 역할로 생성하세요.
조직 제공: 사용자 org_admin 또는 org_super_admin RBAC 키와 org.create 신뢰할 수 있는 자동화만이 조직을 만들 필요가 있는 경우에만 사용하십시오.

API 키를 계속 사용하세요.

만약 __CAPGO_KEEP_0__ 키를 사용 중이라면 API 키 인증 및 계정 흐름을 계획할 때, __CAPGO_KEEP_0__ 키를 @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey 구현 세부 정보에 대한 @capgo/capacitor-passkey 에 대한 @capgo/capacitor-native-biometric 구현 세부 정보에 대한 @capgo/capacitor-native-biometric 에 대한 두 단계 인증 두 단계 인증 및 구현 세부 정보에 대한 SSO (기업) 페이지 편집