組織

Capgoのトップレベルエンティティは組織です。組織を使用して、アプリ、チームメンバー、リソースを単一のカバー下にグループ化できます。各組織には、異なる役割と権限を持つ複数のメンバーが存在できます。

一般的な使用例

• 会社用に新しい組織を作成する
• 組織設定の管理
• 組織情報の更新
• 組織詳細の取得

エンドポイント

GET

https://api.capgo.app/organization/

組織情報を取得します。指定されたパラメータが存在する場合、特定の組織を返します。そうでない場合は、すべてのアクセス可能な組織を返します。 orgId Query Parameters

Section titled “Query Parameters”

• orgId Response Type

Section titled “Response Type”

interface Organization {
  id: string
  created_by: string
  created_at: string
  updated_at: string
  logo: string | null
  name: string
  management_email: string
  customer_id: string | null
}

protectedTokens

# Get all organizations
curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

# Get specific organization
curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/?orgId=org_123

サンプルレスポンス

{
  "data": {
    "id": "org_123",
    "name": "My Company",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "logo": "https://example.com/logo.png",
    "management_email": "admin@example.com",
    "customer_id": "cus_123"
  }
}

POST

https://api.capgo.app/organization/

新しい組織を作成します。

API キーを使用する場合、キーにはグローバル org.create 許可と現在の組織スコープ org_admin または org_super_admin バインディング。 この要求は、ターゲットの組織がまだ存在しないため、通常の組織スコープのRBACがチェックできないため、必要です。

要求が成功すると、Capgoは自動的に同じAPIキーを新しい組織に割り当てます。 org_super_admin 新しい__CAPGO_KEEP_0__キーに

注記

org.create 新しいAPIキーにデフォルトで許可されていません。許可するには、「組織を作成する」許可を有効化するか、APIキーを作成する際に「API」を含める必要があります。 許可するには、「組織を作成する」許可を有効化するか、__CAPGO_KEEP_0__キーを作成する際に「__CAPGO_KEEP_0__」を含める必要があります。 in the API key form, or include "global_permissions": ["org.create"] when creating the key through the API.

コピー

interface OrganizationCreate {
  name: string
  email?: string
  estimatedMau?: number
  website?: string
}

例のリクエスト

curl -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Organization",
    "email": "admin@example.com",
    "website": "https://example.com"
  }' \
  https://api.capgo.app/organization/

例のレスポンス

{
  "id": "org_456"
}

権限エラー

API キーが持たない場合、API は org.create、API が

{
  "error": "permission_denied"
}

PUT

https://api.capgo.app/organization/

PUTを使用して既存の組織を更新します。対象の組織に管理者ロールが必要です。

Request Body

interface OrganizationUpdate {
  orgId: string
  logo?: string
  name?: string
  management_email?: string
}

ターミナル画面

curl -X PUT \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orgId": "org_123",
    "name": "New Company Name",
    "management_email": "newemail@example.com"
  }' \
  https://api.capgo.app/organization/

PUTを使用して既存の組織を更新します。対象の組織に管理者ロールが必要です。

{
  "status": "Organization updated",
  "data": {
    "id": "org_123",
    "name": "New Company Name",
    "management_email": "newemail@example.com"
  }
}

削除

https://api.capgo.app/organization/

既存の組織を削除します。対象の組織に削除権限が必要であり、通常はロールを通じて提供されます。このアクションは不可逆であり、関連するすべてのアプリ、バンドル(バージョン)、およびリソースを削除します。 org_super_admin 削除する組織のID

グローバルな権限では組織を削除することはできません。 org.create クエリ パラメーター

「クエリ パラメーター」のセクション

• orgId例のリクエスト

「例のリクエスト」のセクション

curl -X DELETE \
  -H "x-api-key: YOUR_API_KEY" \
  https://api.capgo.app/organization/?orgId=org_123

例のレスポンス

{
  "status": "ok"
}

エラー処理

一般的なエラーシナリオとそのレスポンス:

// Invalid API key
{
  "error": "Invalid API key",
  "status": "KO"
}

// Missing required field
{
  "error": "Name is required",
  "status": "KO"
}

// Insufficient permissions
{
  "error": "Admin role required",
  "status": "KO"
}

ベストプラクティス

1. 命名規則: 組織名を明確で記述的な名前で設定してください。
2. 役割: チームメンバーに適切な役割を割り当ててください。
3. メールアドレスページ/エリア: Capgo マーケティング ウェブサイト。役割: UI ラベル。表示場所: page register.astro。メッセージキー `email_label` (メールラベル)。| ページ/エリア: ライブアップデート製品ページ。役割: UI ラベル。メッセージキー `live_update_guidance_email_label` (ライブアップデートガイドメールラベル)。
4. : 管理メールアドレスのグループメールを使用して、個人メールの変更による問題を回避してください。ロゴ

: 可靠なCDNでロゴをホストし、HTTPS URLを使用してください。

組織から続けてください。 : 組織名を明確で記述的な名前で設定してください。 to plan dashboard and API operations, connect it with API まとめ API まとめの実装詳細については 導入 導入の実装詳細については API キー API キーの実装詳細については デバイス デバイスの実装詳細については、 バンドル バンドルの実装詳細については。