Membri

I membri dell'organizzazione sono gli utenti che hanno accesso alla tua organizzazione Capgo. Ogni membro ha un ruolo specifico che determina le loro autorizzazioni all'interno dell'organizzazione. La gestione degli utenti in modo efficace è cruciale per mantenere la sicurezza e la collaborazione nel tuo team.

Ruoli dei membri

Ruoli regolari

• read: Può visualizzare le risorse ma non può effettuare modifiche
• upload: Può caricare nuovi bundle e visualizzare le risorse
• write: Può modificare le risorse e caricare bundle
• admin: Può gestire le impostazioni dell'organizzazione e i membri
• super_admin: Ha il controllo completo sull'organizzazione

Ruoli di Invito

• __CAPGO_KEEP_0__: Invito in attesa per l'accesso di lettura
• __CAPGO_KEEP_0__: Invito in attesa per l'accesso di caricamento
• __CAPGO_KEEP_0__: Invito in attesa per l'accesso di scrittura
• __CAPGO_KEEP_0__: Invito in attesa per l'accesso amministrativo
• __CAPGO_KEEP_0__: Invito in attesa per l'accesso super amministrativo

Pratiche Migliori

1. Assegnazione del Ruolo: Segui il principio di minima autorità quando assegni ruoli
2. Verifiche Regolari: Periodicamente rivedi l'accesso dei membri e rimuovi gli account non utilizzati
3. Onboarding: Ha un processo chiaro per l'aggiunta di nuovi membri e l'assegnazione dei ruoli
4. Offboarding: Rimuovi prontamente l'accesso per i membri che lasciano l'organizzazione

Sezione intitolata “Endpoint”

Section titled “Best Practices”

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

Aggiungi un nuovo membro a un'organizzazione o aggiorna il ruolo di un membro esistente. Nota che puoi invitare solo gli utenti che già hanno un account Capgo - l'email deve corrispondere a un utente esistente Capgo.

Corpo della richiesta

interface MemberCreate {
  orgId: string
  email: string
  role: "read" | "upload" | "write" | "admin" | "super_admin"
}

Esempio di richiesta

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "orgId": "org_123",
    "email": "newmember@example.com",
    "role": "write"
  }' \
  https://api.capgo.app/organization/members/

Risposta di successo

{
  "status": "OK",
  "data": {
    "uid": "user_789",
    "email": "newmember@example.com",
    "role": "invite_write",
    "image_url": null
  }
}

Nota:

• Quando si aggiunge un nuovo membro, riceveranno un invito via email. Il loro ruolo sarà prefisso con “invito_” fino a quando non accettano l'invito.
• L'utente deve già avere un account Capgo prima di poter essere invitato. Se non ne ha uno, dovrebbe crearne uno per primo al https://console.capgo.app/register/

GET

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

Ritorna tutti i membri di un'organizzazione.

Parametri di query

interface MemberQuery {
  orgId: string
}

Tipo di Risposta

interface Member {
  uid: string;
  email: string;
  image_url: string;
  role: "invite_read" | "invite_upload" | "invite_write" | "invite_admin" | "invite_super_admin" | "read" | "upload" | "write" | "admin" | "super_admin";
}

Esempio di richiesta

curl -H "authorization: your-api-key" \
  "https://api.capgo.app/organization/members/?orgId=org_123"

Esempio di risposta

{
  "data": [
    {
      "uid": "user_123",
      "email": "john@example.com",
      "image_url": "https://example.com/avatar.png",
      "role": "admin"
    },
    {
      "uid": "user_456",
      "email": "jane@example.com",
      "image_url": "https://example.com/avatar2.png",
      "role": "write"
    },
    {
      "uid": "user_789",
      "email": "bob@example.com",
      "image_url": null,
      "role": "invite_read"
    }
  ]
}

Cancella

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

Elimina un membro da un'organizzazione. Ciò revocherà immediatamente il loro accesso.

Corpo della richiesta

interface MemberDelete {
  orgId: string
  email: string
}

Esempio di richiesta

curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "orgId": "org_123",
    "email": "user@example.com"
  }' \
  https://api.capgo.app/organization/members/

Risposta di successo

{
  "status": "OK"
}

Gestione degli errori

Scenari di errore comuni e le loro risposte:

// Member not found
{
  "error": "Member not found",
  "status": "KO"
}

// Invalid role
{
  "error": "Invalid role specified",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage members",
  "status": "KO"
}

// Cannot remove last admin
{
  "error": "Cannot remove the last admin from the organization",
  "status": "KO"
}

// Invalid email
{
  "error": "Invalid email format",
  "status": "KO"
}

// Member already exists
{
  "error": "Member already exists in organization",
  "status": "KO"
}

Casi d'uso comuni

1. Espansione della squadra: Aggiungere nuovi membri della squadra con ruoli appropriati
2. Controllo dell'accesso: Gestire le autorizzazioni dei membri in base ai cambiamenti delle responsabilità
3. Audit di sicurezza: Recensire la lista dei membri e dei ruoli periodicamente
4. Ristrutturazione della squadra: Aggiornare i ruoli durante i cambiamenti organizzativi

Continua da Members

Se stai utilizzando Membri per pianificare la sicurezza e la conformità, connettilo con Crittografia per il dettaglio di implementazione in Crittografia, Conformità per il dettaglio di implementazione in Conformità, Capgo Scansionatore di Sicurezza per il flusso di lavoro del prodotto in Capgo Scansionatore di Sicurezza, Capgo Sicurezza per il flusso di lavoro del prodotto in Capgo Sicurezza, e Capgo Centro di fiducia per il flusso di lavoro del prodotto nel Capgo Centro di fiducia.