組織

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

一般的な使用例

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

エンドポイント

GET

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

組織情報を取得します。 orgId __CAPGO_KEEP_0__が指定されている場合、指定された組織の情報を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 __CAPGO_KEEP_0__ キーが存在しない場合、通常の組織スコープのRBACを新しい組織にチェックすることはできません。 org_super_admin リクエストが成功した場合、__CAPGO_KEEP_0__ は自動的に新しい組織に同じ __CAPGO_KEEP_1__ キーを割り当てます。

When the request succeeds, Capgo automatically assigns the same API key as org_super_admin POST

Note

org.create は新しいAPIキーに自動的に付与されません。 を有効にするか、キーを作成する際にを含めてください。 in the API key form, or include "global_permissions": ["org.create"] when creating the key through the API.

Request Body

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

Example Request

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/

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

Request Body

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

Example Request

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/

Example Response

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

削除

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

削除応答の例

{
  "status": "ok"
}

コピー

Section titled “

// 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. ベスト プラクティスSection titled “
2. ベスト プラクティス”名前付け法:組織の明確で説明的な名前を使用する。ロール:チーム メンバーに適切なロールを割り当てる。
3. メール: 管理者メールアドレスをグループメールに設定すると、個人のメールアドレス変更による問題を回避できます。
4. ロゴ: 可靠なCDN上でロゴをホストし、HTTPS URLを使用します。

組織から続ける

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