Membres

Les membres de l'organisation sont les utilisateurs qui ont accès à votre organisation Capgo. Chaque membre a un rôle spécifique qui détermine ses autorisations au sein de l'organisation. Gérer efficacement les membres est crucial pour maintenir la sécurité et la collaboration dans votre équipe.

Rôles des membres

Rôles réguliers

• lire: Peut consulter les ressources mais ne peut pas faire de changements
• upload: Puiser des nouveaux ensembles et afficher les ressources
• write: Puiser des ressources et des ensembles
• admin: Gérer les paramètres et les membres de l'organisation
• super_admin: Contrôle total sur l'organisation

Inviter des Rôles

• invite_read: Invitation en attente pour l'accès en lecture
• invite_uploadEn attente d'invitation pour l'accès à l'upload
• invite_writeEn attente d'invitation pour l'accès à l'écriture
• invite_adminEn attente d'invitation pour l'accès à l'administration
• invite_super_adminEn attente d'invitation pour l'accès à l'administration supérieure

Meilleures Pratiques

1. Attribution de RôleSuivez le principe de la plus petite privilège lors de l'attribution de rôle
2. Audits régulières: Vérifiez périodiquement l'accès des membres et supprimez les comptes inutilisés
3. Inscription: Ayez un processus clair pour ajouter de nouveaux membres et assigner des rôles
4. Déconnexion: Supprimez rapidement l'accès pour les membres qui quittent l'organisation

Points de terminaison

POST

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 ont déjà un compte Capgo - l'adresse e-mail doit correspondre à un utilisateur existant Capgo.

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 électronique 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'ont pas de compte, ils devraient créer un d'abord sur 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"

Réponse d'exemple

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

Retirer un membre d'une organisation. Cela revocera immédiatement leur accès.

Corps de la demande

interface MemberDelete {
  orgId: string
  email: string
}

Exemple de demande

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. Équipe Élargie: Ajouter de nouveaux membres de l'équipe avec des rôles appropriés
2. Contrôle d'accès: Gérer les permissions des membres en fonction des changements de responsabilités
3. Vérification de la sécurité: Examiner régulièrement la liste des membres et leurs rôles
4. Réorganisation de l'équipe: Mettre à jour les rôles pendant les changements organisationnels

Continuez depuis Membres

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