Organisationen

Organisationen sind die obersten Einheiten in Capgo. Sie ermöglichen es Ihnen, Apps, Teammitglieder und Ressourcen unter einer einzigen Dachmarke zu gruppieren. Jede Organisation kann mehrere Mitglieder mit unterschiedlichen Rollen und Berechtigungen haben.

Häufige Verwendungsfälle

• Erstellung einer neuen Organisation für Ihr Unternehmen
• Verwaltung der Organisationseinstellungen
• Aktualisierung der Organisationsinformationen
• Abrufen von Organisationsdetails

Endpunkte

GET

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

Organisationsinformationen abrufen. Wenn ein Wert in den Parametern angegeben ist, wird eine einzelne Organisation zurückgegeben. Ansonsten werden alle zugänglichen Organisationen zurückgegeben. orgId Abfrageparameter

Abschnitt mit dem Titel “Abfrageparameter”

• orgId Antworttyp

Abschnitt mit dem Titel “Antworttyp”

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
}

protectedTokens

# 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

Beispielantwort

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

Eine neue Organisation erstellen.

Wenn Sie einen API-Schlüssel verwenden, muss der Schlüssel die globale Berechtigung und eine aktuelle Organisationsscope-Berechtigung haben oder org.create Oder org_admin Wenn Sie einen __CAPGO_KEEP_0__-Schlüssel verwenden, muss der Schlüssel die globale Berechtigung und eine aktuelle Organisationsscope-Berechtigung haben oder org_super_admin bindung. Dies ist erforderlich, weil das Zielorganisation noch nicht existiert, daher kann die normale Organisation-RBAC nicht gegen sie geprüft werden.

Wenn die Anfrage erfolgreich ist, wird Capgo automatisch dem neuen API-Schlüssel denselben Schlüssel zuweisen wie org_super_admin auf der neuen Organisation.

Hinweis

org.create ist nicht standardmäßig den neuen API-Schlüsseln erteilt. Aktivieren Sie Organisationen erstellen in der API-Schlüssel-Form oder fügen Sie "global_permissions": ["org.create"] wenn Sie den Schlüssel über die API erstellen.

Anforderungskörper

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

Beispielanfrage

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/

Beispielantwort

{
  "id": "org_456"
}

Zugriffsfehler

Wenn der Schlüssel API nicht vorhanden ist, org.createder API gibt zurück:

{
  "error": "permission_denied"
}

PUT

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

Ein bestehendes Unternehmen aktualisieren. Erfordert die Rolle des Administrators im Zielunternehmen.

Anforderungskörper

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

Beispielanfrage

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/

Beispielergebnis

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

LÖSCHEN

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

Eine bestehende Organisation löschen. Erfordert die Löscherecht auf der Zielorganisation, typischerweise über die org_super_admin Rolle. Diese Aktion ist unwiderruflich und entfernt alle verbundenen Apps, Pakete (Versionen) und Ressourcen.

Der org.create globale Berechtigung erlaubt nicht das Löschen von Organisationen.

Abfrageparameter

• orgIdDie ID der Organisation, die gelöscht werden soll

Beispielanfrage

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

Beispielantwort

{
  "status": "ok"
}

Fehlerbehandlung

Häufige Fehlerfälle und ihre Antworten:

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

Gute Praxis

1. Benennung: Verwenden Sie für Organisationen klare und beschreibende Namen
2. Rollen: Zuordnen Sie angemessene Rollen zu Teammitgliedern
3. E-Mail: Verwenden Sie eine Gruppen-E-Mail für management_email, um Probleme mit persönlichen E-Mail-Änderungen zu vermeiden
4. Logo: Hosten Sie Logos auf einem zuverlässigen CDN und verwenden Sie HTTPS-URLs

Fortsetzen von Organisationen

Organisationen : Zuordnen Sie angemessene Rollen zu Teammitgliedern to plan dashboard and API operations, connect it with API Übersicht für die Implementierungsdetails in API Übersicht Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel Geräte für die Implementierungsdetails in Geräte und Pakete für die Implementierungsdetails in Pakete.