Organizaciones

Las organizaciones son las entidades de nivel superior en Capgo. Permiten agrupar aplicaciones, miembros del equipo y recursos bajo un solo paraguas. Cada organización puede tener varios miembros con roles y permisos diferentes.

Uso común

• Crear una nueva organización para tu empresa
• Gestionar ajustes de organización
• Actualizar información de organización
• Obtener detalles de organización

Puntos finales

GET

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

Obtener información de la organización. Si se proporciona en los parámetros, devuelve una organización única. De lo contrario, devuelve todas las organizaciones accesibles. orgId Parámetros de consulta

Sección titulada “Parámetros de consulta”

• orgId Tipo de respuesta

Sección titulada “Tipo de respuesta”

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

Respuesta de ejemplo

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

Crear una nueva organización.

Cuando se utiliza una clave API, la clave debe tener la permisión global y una organización-scopada actual org.create o org_admin o org_super_admin vinculación. Esto es necesario porque la organización objetivo no existe aún, por lo que el RBAC normalmente escopado a la organización no se puede verificar contra ella.

Cuando la solicitud tiene éxito, Capgo asigna automáticamente la misma clave API como org_super_admin en la nueva organización.

Nota

org.create no se concede por defecto a nuevas claves API. Active Permitir la creación de organizaciones en la forma de clave API, o incluya "global_permissions": ["org.create"] cuando se crea la clave a través de API.

Cuerpo de la solicitud

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

Solicitud de ejemplo

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/

Respuesta de ejemplo

{
  "id": "org_456"
}

Error de permiso

Si la clave API no tiene org.createel API devuelve:

{
  "error": "permission_denied"
}

PUT

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

Actualizar una organización existente. Requiere el rol de administrador en la organización objetivo.

Solicitud de cuerpo

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

Pedido de ejemplo

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/

Respuesta de ejemplo

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

ELIMINAR

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

Eliminar una organización existente. Requiere permiso de eliminación en la organización objetivo, típicamente a través del org_super_admin rol. Esta acción es irreversible y eliminará todos los aplicativos asociados, conjuntos (versiones) y recursos.

El org.create permiso global no permite eliminar organizaciones.

Parámetros de consulta

• orgId: El ID de la organización a eliminar

Solicitud de ejemplo

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

Respuesta de ejemplo

{
  "status": "ok"
}

Gestión de errores

Escenarios de errores comunes y sus respuestas:

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

Prácticas recomendadas

1. NombradoUse nombres claros y descriptivos para organizaciones
2. RolesAssignar roles adecuados a los miembros del equipo
3. Correo electrónicoUse un correo electrónico grupal para management_email para evitar problemas con cambios de correo electrónico personal
4. LogoAlbergue logos en un CDN confiable y utilice URLs HTTPS

Siga adelante desde Organizaciones

Si está utilizando Organizaciones para planificar tableros de control y API operaciones, conecte con API Resumen para el detalle de implementación en API Resumen Introducción para el detalle de implementación en Introducción API Claves para el detalle de implementación en API Claves Dispositivos para el detalle de implementación en Dispositivos, y Paquetes para el detalle de implementación en Paquetes.