組織

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

一般的な使用例

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

エンドポイント

GET

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

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

セクション：クエリ パラメータ

• orgId レスポンス タイプ

セクション：レスポンス タイプ

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
}

__CAPGO_KEEP_0__

# 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"
  }
}

組織を作成します。

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

または

When using an API key, the key must have the global org.create アプリフロー プラグインか、Capawesome プラグインか org_admin または org_super_admin バインディング。 この要求は、ターゲットの組織がまだ存在しないため、通常の組織スコープのRBACがチェックできないため、必要です。

要求が成功した場合、Capgoは自動的に同じAPIキーを新しい組織に割り当てます。 org_super_admin 注記

新しい__CAPGO_KEEP_0__キーに__CAPGO_KEEP_1__キーが自動的に割り当てられます。

org.create is not granted to new API keys by default. Enable 組織を作成する APIキー形式で、またはAPIを通じてキーを作成する際に__CAPGO_KEEP_1__を含める必要があります。 "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を使用して既存の組織を更新します。対象の組織に管理者ロールが必要です。

リクエストボディ

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例:削除要求

Section titled “DELETE”

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ラベル。表示場所:ページregister.astro。メッセージキー`email_label` (メールラベル)。|コンテキスト:ライブアップデートの製品ページ。役割:UIラベル。メッセージキー`live_update_guidance_email_label` (ライブアップデートガイドのメールラベル)。
4. : 管理用メールアドレスにグループメールを使用して、個人メールの変更による問題を回避してください。ロゴ

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

タイトル「組織から続けて」 : 組織を使用してダッシュボードと__CAPGO_KEEP_0__の運用を計画している場合、 組織を使用してダッシュボードとAPIの運用を計画している場合、 API Overview API の概要 Introduction 実装の詳細については __CAPGO_KEEP_0__ Overview を参照してください API Keys API キーの概要 Devices 実装の詳細については Devices を参照してください、そして Bundles 実装の詳細については Bundles を参照してください。