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é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érer les informations de l'organisation. Si un identifiant est fourni dans les paramètres, renvoie une organisation unique. Sinon, renvoie toutes les organisations accessibles. orgId Paramètres de requête

Titre de la section « Paramètres de requête »

• orgId Type de réponse

Titre de la section « 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
}

__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

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.

Lorsque vous utilisez une clé API, la clé doit avoir la permission globale et une organisation-scopée actuelle org.create ou org_admin ou org_super_admin binding. Cela est requis car l'organisation cible n'existe pas encore, donc la RBAC normal scoping ne peut pas être vérifiée contre elle.

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

La clé __CAPGO_KEEP_0__ n'a pas la permission par défaut. Activez la possibilité de créer des organisations dans la clé __CAPGO_KEEP_0__ sous forme de clé, ou incluez

org.create is not granted to new API keys by default. Enable dans la clé __CAPGO_KEEP_0__. in the API key form, or include "global_permissions": ["org.create"] when creating the key through the API.

Section intitulée “Corps de la demande”

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

Exemple de requête

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 de valeur, la clé API retourne : org.create, the API returns:

{
  "error": "permission_denied"
}

MAJ

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

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

Le org.create permis global 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. Nommer: Utilisez des noms décrisifs clairs pour les organisations
2. Rôles: Attribuez des rôles appropriés aux membres de l'équipe
3. Adresse e-mailcontext : Page/zone : Site web de marketing Capgo. Rôle : Étiquette UI. Vue dans : page register.astro. Clé de message `email_label` (Étiquette d'adresse e-mail). | Page/zone : Page de produits de mises à jour en direct. Rôle : Étiquette UI. Clé de message `live_update_guidance_email_label` (Étiquette d'adresse e-mail de la guidance de mise à jour en direct).
4. : Utilisez un groupe d'adresses e-mail pour la gestion de l'email pour éviter les problèmes avec les changements d'adresse e-mail personnelleLogo

: Héberger les logos sur un CDN fiable et utiliser des URL HTTPS

Titre de la section « Continuez de la section Organisations » Si vous utilisez Organisations pour planifier votre tableau de bord et vos API opérations, connectez-l’avec API Présentation pour le détail d'implémentation dans API Présentation Introduction pour le détail d'implémentation dans Introduction API Clés pour le détail d'implémentation dans API Clés Appareils pour le détail d'implémentation dans Appareils, et Ensembles pour le détail d'implémentation dans Ensembles.