Organisations

Les organisations sont les entités de niveau supérieur dans Capgo. Elles vous permettent de grouper les applications, les membres d'équipe et les ressources sous un même drapeau. Chaque organisation peut avoir plusieurs membres avec des rôles et des permissions différents.

Utilisations courantes

• Créer une nouvelle organisation pour votre entreprise
• Gestion des paramètres d'organisation
• Mise à jour des informations d'organisation
• Récupération des détails d'organisation

Points de terminaison

GET

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

Récupérer les informations d'organisation. Si un identifiant est fourni dans les paramètres, retourne une organisation unique. Sinon, retourne toutes les organisations accessibles. orgId Paramètres de requête

Paramètres de requête

• orgId (facultatif) : L'ID de l'organisation spécifique à récupérer

Type de réponse

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
}

Exemple de requête

# 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

Exemple de réponse

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

Créer une nouvelle organisation.

Lors de l'utilisation d'une clé API, la clé doit avoir la permission globale et une organisation actuelle. org.create ou org_admin une liaison. Cela est requis car l'organisation cible n'existe pas encore, donc la RBAC normalisée ne peut pas être vérifiée contre elle. org_super_admin Lorsque la demande réussit, __CAPGO_KEEP_0__ attribue automatiquement la même clé __CAPGO_KEEP_1__ à

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

n'est pas accordée par défaut aux nouvelles clés __CAPGO_KEEP_0__. Activer

org.create is not granted to new API keys by default. Enable Permettre la création d'organisations dans la forme de clé API, ou inclure "global_permissions": ["org.create"] lors de la création de la clé à travers le API.

Corps de la demande

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

Exemple de demande

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/

Exemple de réponse

{
  "id": "org_456"
}

Erreur de permission

Si la clé API n'a pas org.create, la API retourne:

{
  "error": "permission_denied"
}

Mettre à jour

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

Mettre à jour une organisation existante. Exige le rôle d'administrateur sur l'organisation cible.

Corps de la demande

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

Exemple de requête

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/

Exemple de réponse

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

SUPPRIMER

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

Supprimer une organisation existante. Exige la permission de suppression sur l'organisation cible, généralement à travers le « rôle ». Cette action est irréversible et supprimera tous les applications associées, les lots (versions) et les ressources. org_super_admin __CAPGO_KEEP_0__

__CAPGO_KEEP_1__ org.create Les permissions globales ne permettent pas la suppression d'organisations.

Paramètres de requête

• orgId: L'ID de l'organisation à supprimer

Exemple de requête

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

Exemple de réponse

{
  "status": "ok"
}

Gestion des erreurs

Scénarios d'erreurs courants et leurs réponses :

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

Meilleures pratiques

1. Pratiques recommandéesNoms
2. : Utilisez des noms clairs et descriptifs pour les organisationsRôles
3. : Attribuez des rôles appropriés aux membres de l'équipeCourriel
4. : Utilisez un courriel de groupe pour management_email afin d'éviter les problèmes liés aux changements d'adresse e-mail personnelle: Héberger des logos sur un CDN fiable et utiliser des URL HTTPS

Continuez d'Organisations

Si vous utilisez Organisations pour planifier le tableau de bord et les opérations API, connectez-le à API Overview pour les détails d'implémentation dans API Overview, Introduction pour les détails d'implémentation dans Introduction, API Keys pour les détails d'implémentation dans API Keys Appareils pour le détail d'implémentation dans Appareils, et Paquets pour le détail d'implémentation dans Paquets.