Organisations

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

Utilisations courantes

• Création d'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érez les informations de l'organisation. Si orgId est fourni dans les paramètres, retourne une seule organisation. Sinon, retourne toutes les organisations accessibles.

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

Réponse d'exemple

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

Lorsque vous utilisez une clé API, la clé doit avoir la permission globale et une clé organisation-scopée actuelle org.create ou org_admin de liaison. Cela est requis car l'organisation cible n'existe pas encore, donc la vérification normale de l'autorisation RBAC organisation-scopée ne peut pas être effectué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 sur la nouvelle organisation.

Note

org.create n'est pas accordé par défaut aux nouvelles clés API. Activer Autoriser 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é via 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/

Réponse d'exemple

{
  "id": "org_456"
}

Erreur de permission

Si la clé API n'a pas org.create, la valeur de la clé API est :

{
  "error": "permission_denied"
}

Mettre à jour (PUT)

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 demande

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 via le org_super_admin rôle. Cette action est irréversible et supprimera tous les applications associées, les lots (versions) et les ressources.

La org.create permission globale ne permet pas de supprimer les 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

Réponse d'exemple

{
  "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. NommerUtilisez des noms clairs et descriptifs pour les organisations
2. Rôles: Assigner des rôles appropriés aux membres de l'équipe
3. Courriel: Utiliser un courriel de groupe pour le paramètre management_email afin d'éviter les problèmes liés aux changements de courriel personnel
4. Logo: Héberger les logos sur un CDN fiable et utiliser des URL HTTPS

Continuez d'en Organizations

Organisations pour planifier le tableau de bord et les opérations __CAPGO_KEEP_0__, connectez-le à API Overview pour les détails d'implémentation dans API Overview, for the implementation detail in API Overview, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, Appareils pour les détails d'implémentation dans Appareils, et Paquets pour les détails d'implémentation dans Paquets.