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.

Gemeinsame Verwendungsfälle

• Erstellen einer neuen Organisation für Ihr Unternehmen
• Verwalten von Organisationseinstellungen
• Aktualisieren von Organisationsinformationen
• Abrufen von Organisationsdetails

Abschnitt mit dem Titel „Endpunkte“

Abschnitt mit dem Titel „GET“

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

Organisationsinformation abrufen. Wenn orgId angegeben ist, wird eine einzelne Organisation zurückgegeben. Ansonsten werden alle zugänglichen Organisationen zurückgegeben.

Abfrageparameter

• orgId (optional): Die ID der spezifischen Organisation, die abgerufen werden soll

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
}

Beispielanfrage

# 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 bei der Verwendung eines API-Schlüssels sicherstellen müssen, dass der Schlüssel die globale Berechtigung und eine aktuelle Organisation-scope Berechtigung hat, oder org.create dies ist erforderlich, da die Zielorganisation noch nicht existiert, sodass normale Organisation-scope RBAC nicht gegen sie überprüft werden kann. org_admin Wenn die Anfrage erfolgreich ist, __CAPGO_KEEP_0__ stellt den __CAPGO_KEEP_1__-Schlüssel automatisch auf dem neuen Organisation gleich. org_super_admin Beispielantwort

When the request succeeds, Capgo automatically assigns the same API key as org_super_admin Auf die Zwischenablage kopieren

Hinweis

org.create wird neuen API Schlüsseln standardmäßig nicht gewährt. Aktivieren Sie Erlauben Sie die Erstellung von Organisationen in der API-Schlüssel-Form, oder "global_permissions": ["org.create"] beim Erstellen des Schlüssels über die API.

Anfrage-Body

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 zurückgibt:

{
  "error": "permission_denied"
}

PUT

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

Ein bestehendes Unternehmen aktualisieren. Erfordert die Rolle Admin auf dem 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 die Zielorganisation, typischerweise über die Rolle. Diese Aktion ist unwiderruflich und wird alle zugehörigen Apps, Pakete (Versionen) und Ressourcen entfernen. org_super_admin Benötigt Löscherecht auf die Zielorganisation, typischerweise über die Rolle.

Diese Aktion ist unwiderruflich und wird alle zugehörigen Apps, Pakete (Versionen) und Ressourcen entfernen. org.create Die globale Berechtigung ermöglicht nicht das Löschen von Organisationen.

Abfrageparameter

• orgIdDie ID der zu löschenden Organisation

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 Fehlerzenarien 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 Praktiken

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

Weitermachen von Organisationen

Wenn du Organisationen verwendest, um das Dashboard und API-Operationen zu planen, verbinde es mit 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 Pakete für die Implementierungsdetails in Pakete