Membres

Organization members are users who have access to your Capgo organization. Each member has a specific role that determines their permissions within the organization. Managing members effectively is crucial for maintaining security and collaboration in your team.

Section intitulée « Rôles des membres »

Rôles réguliers

• lire : Peut consulter les ressources mais ne peut pas les modifier
• envoyer : Peut envoyer de nouveaux bundles et consulter les ressources
• écrire : Peut modifier les ressources et envoyer des bundles
• administrateur : Peut gérer les paramètres de l'organisation et les membres
• super administrateur : Possède le contrôle total sur l'organisation

Rôles d'invitation

• invite_read : En attente d'invitation pour l'accès en lecture
• invite_upload : En attente d'invitation pour l'accès à l'upload
• invite_write : En attente d'invitation pour l'accès à l'écriture
• invite_admin : En attente d'invitation pour l'accès à l'administration
• invite_super_admin : En attente d'invitation pour l'accès à l'administration supérieure

Meilleures Pratiques

1. Attribution de rôleSuivez le principe de la plus faible autorité lors de l'attribution de rôles
2. Audits réguliersVérifiez périodiquement l'accès des membres et supprimez les comptes inutilisés
3. IncorporationDisposez d'un processus clair pour ajouter de nouveaux membres et attribuer des rôles
4. DémissionSupprimez rapidement l'accès pour les membres qui quittent l'organisation

Section intitulée « Endpoints »

Section titled “Best Practices”

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

Ajoutez un nouveau membre à une organisation ou mettez à jour le rôle d'un membre existant. Notez que vous pouvez uniquement inviter des utilisateurs qui disposent déjà d'un compte Capgo - l'adresse e-mail doit correspondre à un utilisateur Capgo existant.

Corps de la demande

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

Exemple de demande

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/

Réponse de succès

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

Remarques :

• Lors de l'ajout d'un nouveau membre, ils recevront un courrier d'invitation. Leur rôle sera précédé de “invite_” jusqu'à ce qu'ils acceptent l'invitation.
• L'utilisateur doit déjà avoir un compte Capgo avant qu'il puisse être invité. Si ils n'en ont pas, ils devraient créer un d'abord à https://console.capgo.app/register/

GET

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

Récupérer tous les membres d'une organisation.

Paramètres de requête

interface MemberQuery {
  orgId: string
}

Type de réponse

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

Exemple de requête

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

Exemple de réponse

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

Supprimer

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

Supprimer un membre d'une organisation. Cela révoquera immédiatement leur accès.

Corps de la requête

interface MemberDelete {
  orgId: string
  email: string
}

Exemple de requête

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/

Réponse de succès

{
  "status": "OK"
}

Gestion des erreurs

Scénarios d'erreurs courants et leurs réponses :

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

Utilisations courantes

1. Élargissement de l'équipeAjout de nouveaux membres de l'équipe avec des rôles appropriés
2. Contrôle d'accèsGestion des permissions des membres en fonction des changements de responsabilités
3. Vérification de sécuritéExamen de la liste des membres et des rôles périodiquement
4. Réorganisation de l'équipeMise à jour des rôles pendant les changements organisationnels

Continuez de la section Membres

Si vous utilisez Membres Membres pour planifier la sécurité et la conformité, connectez-l’à Chiffrement pour le détail d’implémentation dans Chiffrement, Conformité Capgo Security Scanner Capgo Scanner de sécurité pour le flux de travail du produit dans Capgo Scanner de sécurité, Capgo Sécurité Capgo Centre de confiance pour le flux de travail du produit dans Capgo Centre de confiance.