组织

Capgo 的顶级实体是组织。它们允许您将应用程序、团队成员和资源组合在一个单独的帆布下。每个组织都可以有多个具有不同角色和权限的成员。

常见用例

• 为您的公司创建新组织
• 管理组织设置
• 更新组织信息
• 获取组织详细信息

API 端点

GET

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

获取组织信息。如果 orgId 如果在参数中提供，则返回单个组织；否则，返回所有可访问的组织。

参数查询

• 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
}

Section titled “Example Request”

# 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 or org_super_admin context

当请求成功时，Capgo 会自动将相同的 API 密钥 assignments 给予 org_super_admin 在新组织中。

注意

org.create API密钥的新组织权限默认不授予。启用 允许创建组织 在API密钥表单中创建组织，或在创建密钥时包含 "global_permissions": ["org.create"] 在创建密钥时通过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.create则API返回：

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

删除

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

删除一个现有的组织。需要在目标组织上删除权限，通常通过 org_super_admin 角色。这一操作不可逆转，会移除所有相关的应用、版本和资源。

The org.create 全局权限不允许删除组织。

参数查询

• orgId: 要删除的组织的 ID

示例请求

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. Email: 使用一个组邮箱来避免个人邮箱变更带来的问题
4. Logo: 将Logo托管在可靠的CDN上并使用HTTPS URL

继续从组织

如果您正在使用 组织 来规划仪表板和API操作，连接它与 API概览 了解API概览中的实施细节 简介 简介的实现细节 API 键 API 键的实现细节 设备 设备的实现细节 包 包的实现细节