Membres

Membres de l'organisation sont des 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.

Membres et rôles

Membres et rôles

• : Peut consulter les ressources mais ne peut pas les modifierTélécharger
• : Peut télécharger de nouveaux ensembles et consulter les ressourcesÉcrire
• : Peut modifier les ressources et télécharger des ensemblesadmin
• readGestion de paramètres et d'adhérents de l'organisation
• super_adminGestion des paramètres de l'organisation

Inviter des rôles

• invite_readInvitation en attente pour accéder en lecture
• invite_uploadInvitation en attente pour accéder à l'upload
• invite_writeInvitation en attente pour accéder à l'écriture
• invite_admin: En attente d'invitation pour l'accès administrateur
• invite_super_admin: En attente d'invitation pour l'accès super administrateur

Meilleures Pratiques

1. Affectation de Rôle: Suivre le principe de la plus petite privilègue lors de l'affectation de rôle
2. Vérifications Régulières: Passer régulièrement en revue l'accès des membres et supprimer les comptes inutilisés
3. Intégration: Disposer d'un processus clair pour l'ajout de nouveaux membres et l'affectation de rôle
4. DéintégrationRetirez immédiatement l'accès aux 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 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 é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 à 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 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. É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 la sécurité: Vérifiez régulièrement la liste des membres et leurs rôles
4. Équipe de Restructuration: Mettre à jour les rôles lors de changements organisationnels

Continuez de la section Membres

Si vous utilisez Membres pour planifier la sécurité et la conformité, connectez-le avec Chiffrement pour les détails d'implémentation dans Chiffrement, Conformité pour les détails d'implémentation dans Conformité, Capgo Scanner de sécurité pour le flux de workflow du produit dans Capgo Scanner de sécurité, Capgo Sécurité pour le flux de workflow du produit dans Capgo Sécurité, et Capgo Centre de confiance pour le flux de workflow du produit dans Capgo Centre de confiance.