Membri

I membri dell'organizzazione sono gli utenti che hanno accesso alla tua organizzazione Capgo. Ogni membro ha un ruolo specifico che determina i suoi permessi all'interno dell'organizzazione. Gestire efficacemente i membri è fondamentale per mantenere la sicurezza e la collaborazione nel tuo team.

Ruoli dei membri

Ruoli standard

• letto: può visualizzare le risorse ma non modificarle
• 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
• ruolo super_admin: ha il controllo totale sull'organizzazione

Ruoli di invito

• lettura_inviti: invito in sospeso con permessi di sola lettura
• invita_upload: invito in sospeso con permessi di upload
• invite_write: Invito in sospeso per accesso in scrittura
• invita_admin: Invito in sospeso per accesso admin
• invita_super_amministratore: Invito in sospeso per accesso super admin

Best practice

1. Assegnazione ruoli: Segui il principio del minimo privilegio quando assegni i ruoli
2. Audit regolari: Rivedi periodicamente l'accesso dei membri e rimuovi gli account non utilizzati
3. Onboarding: Avere un processo chiaro per aggiungere nuovi membri e assegnare i ruoli
4. Offboarding: Rimuovere tempestivamente l'accesso per i membri che lasciano l'organizzazione

Endpoint

POST

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

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

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

Note:

• Quando aggiungi un nuovo membro, riceverà un'email di invito. Il suo ruolo avrà il prefisso “invite_” finché non accetterà l'invito.
• L'utente deve già avere un account Capgo prima di poter essere invitato. Se non ha un account, deve prima crearne uno su https://capgo.app/register/

GET

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

Recupera 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"

Risposta di esempio

{
  "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"
    }
  ]
}

ELIMINA

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

Rimuovi un membro da un'organizzazione. Questo revoca 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

Tutti gli errori seguono il formato standard descritto nella Panoramica di API.

Scenari di errore comuni e relative risposte:

// The API key has no access to the organization
{
  "error": "cannot_access_organization",
  "message": "You can't access this organization",
  "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }
}

// Unknown role on update
{
  "error": "invalid_role",
  "message": "Invalid role",
  "moreInfo": { "role": "owner" }
}

// Changing the role of the user who owns the API key
{
  "error": "cannot_change_own_role",
  "message": "You cannot change your own role",
  "moreInfo": {}
}

// Removing a user who is not a member (HTTP 404)
{
  "error": "organization_member_not_found",
  "message": "User is not a member of this organization",
  "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8", "email": "user@example.com" }
}

// Removing the last super admin
{
  "error": "CANNOT_REMOVE_LAST_SUPER_ADMIN",
  "message": "Cannot remove the last super admin from the organization",
  "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }
}

Casi d'uso comuni

1. Espansione del team: Aggiunta di nuovi membri del team con i ruoli appropriati
2. Controllo degli accessi: Gestione dei permessi dei membri al variare delle responsabilità
3. Audit di sicurezza: Revisione periodica dell'elenco dei membri e dei ruoli
4. Riorganizzazione del team: Aggiornamento dei ruoli durante i cambiamenti organizzativi

Continua da Members

Se stai usando Membri per pianificare sicurezza e compliance, collegalo a Crittografia per i dettagli di implementazione della crittografia, Conformità per i dettagli di implementazione in Compliance, Security Scanner di Capgo per il workflow del prodotto in Capgo Security Scanner, Sicurezza Capgo per il workflow del prodotto in Capgo Security, e Trust Center di Capgo per il workflow del prodotto in Capgo Trust Center.