Organizations

Gli organizzazioni sono le entità di livello superiore in Capgo. Consentono di raggruppare applicazioni, membri del team e risorse sotto un unico ombrello. Ogni organizzazione può avere più membri con ruoli e autorizzazioni diversi.

Casi d'uso comuni

• Gestisci le impostazioni dell'organizzazione
• Gestione delle impostazioni dell'organizzazione
• Updating organization information
• Recupero dei dettagli dell'organizzazione

Punti di accesso

GET

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

Ritorna le informazioni dell'organizzazione. Se orgId Restituisce un'organizzazione se specificata nel parametro, altrimenti tutte le organizzazioni accessibili.

Sezione intitolata “Parametri di query”

• orgId (opzionale): L'ID dell'organizzazione specifica da recuperare

Aggiornamento delle informazioni dell'organizzazione

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
}

Esempio di richiesta

# 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

Esempio di risposta

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

Crea una nuova organizzazione.

Quando si utilizza una chiave API, la chiave deve avere la global org.create permesso e un'organizzazione attuale org_admin or org_super_admin La binding è richiesta perché l'organizzazione di destinazione non esiste ancora, quindi non è possibile eseguire il controllo RBAC normale a livello di organizzazione.

Quando la richiesta ha successo, Capgo assegna automaticamente la stessa chiave API org_super_admin sulla nuova organizzazione.

Note

org.create nella forma di chiave API, o includi quando si crea la chiave attraverso __CAPGO_KEEP_0__. nella forma della chiave API, o includere "global_permissions": ["org.create"] quando si crea la chiave tramite il API.

Richiesta di corpo

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

Esempio di Richiesta

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/

Fermata di terminale

{
  "id": "org_456"
}

Sezione intitolata “Esempio di risposta”

Se la chiave API non è presente org.createallora API restituisce:

{
  "error": "permission_denied"
}

PUT

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

Aggiorna un'organizzazione esistente. Richiede il ruolo di amministratore sull'organizzazione di destinazione.

Corpo della richiesta

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

Esempio di richiesta

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/

Risposta di esempio

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

Cancella

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

Cancella un'organizzazione esistente. Richiede la possibilità di cancellare l'organizzazione bersaglio, di solito attraverso il org_super_admin ruolo. Questa azione è irreversibile e eliminerà tutti gli app associati, bundle (versioni) e risorse.

La org.create permessione globale non consente di cancellare le organizzazioni.

Parametri di query

• orgId: L'ID dell'organizzazione da eliminare

Richiesta di esempio

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

Risposta di Esempio

{
  "status": "ok"
}

Risposta di esempio

Scenari di errori comuni e le loro risposte:

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

Pratiche Consigliate

1. NominativiUsa nomi chiari e descrittivi per le organizzazioni
2. Roles: Utilizzare nomi descrittivi e chiari per le organizzazioni
3. RuoliUsa un indirizzo email del gruppo per management_email per evitare problemi con le modifiche all'indirizzo email personale.
4. LogoHostate i logo sul CDN affidabile e utilizzate gli URL HTTPS

Continua da Organizzazioni

Se stai utilizzando Organizzazioni per pianificare dashboard e operazioni di API, collega il tuo account a Panoramica del API per i dettagli di implementazione in API Overview Introduzione per i dettagli di implementazione in Introduzione Chiavi API per i dettagli di implementazione in API Keys Dispositivi per i dettagli di implementazione in Dispositivi, e Bundle per i dettagli di implementazione nei Pacchetti.