組織

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

一般的な使用例

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

エンドポイント

GET

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

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

クエリ パラメータ

• orgId (省略可能): 取得する特定の組織の ID

レスポンス タイプ

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
}

例

# 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_1__

注意

org.create 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 キーがなければ org.createAPI が返します:

{
  "error": "permission_denied"
}

PUT

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

既存の組織を更新するには、対象組織に管理者権限が必要です。

リクエスト ボディ

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/

例のレスポンス

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

DELETE

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

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

クエリ パラメータ org.create セクション「クエリ パラメータ」

削除する組織の ID

• orgIdセクション「例:リクエスト」

ターミナル ウィンドウ

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

role. This action is irreversible and will remove all associated apps, bundles (versions), and resources.

{
  "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. メール: 管理者メールアドレスをグループメールに設定すると、個人のメールアドレス変更による問題を回避できます。
4. ロゴ: ロゴを安全なCDNにホストし、HTTPS URLを使用します。

組織から続ける

組織を使用している場合 組織 計画用ダッシュボードとAPIの実行を計画するために、組織をAPIの概要と接続します。 APIの概要 APIの概要の実装詳細については、APIの概要を参照してください。 導入 導入の詳細 API キー API キーの詳細 デバイス __CAPGO_KEEP_0__ の詳細 バンドル __CAPGO_KEEP_0__ の詳細