Membres

Les membres de l'organisation sont les utilisateurs qui ont accès à votre organisation Capgo. Chaque membre possède un rôle spécifique qui détermine ses permissions au sein de l'organisation. Une gestion efficace des membres est essentielle pour maintenir la sécurité et la collaboration dans votre équipe.

Rôles des membres

Rôles standards

• lecture: Can view resources but cannot make changes
• upload: Peut envoyer de nouveaux bundles et consulter les ressources
• write: Peut modifier les ressources et envoyer des bundles
• admin: Peut gérer les paramètres de l’organisation et les membres
• rôle super_admin: A le contrôle total de l’organisation

Rôles d’invitation

• invite_read: Invitation en attente pour un accès en lecture
• invite_upload: Invitation en attente pour un accès en upload
• invite_write : Invitation en attente pour l'accès en écriture
• inviter_admin : Invitation en attente pour l'accès admin
• invite_super_admin : Invitation en attente pour l'accès super admin

Bonnes pratiques

1. Attribution des rôles : Appliquez le principe du moindre privilège lors de l'attribution des rôles
2. Audits réguliers : Vérifiez régulièrement les accès des membres et supprimez les comptes inutilisés
3. Onboarding: Disposer d’un processus clair pour l’ajout de nouveaux membres et l’attribution des rôles
4. Offboarding: Retirer rapidement l’accès des membres qui quittent l’organisation

Endpoints

POST

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

Ajouter un nouveau membre à une organisation ou mettre à jour le rôle d’un membre existant. Notez que vous ne pouvez inviter que des utilisateurs disposant déjà d’un compte Capgo - l’e-mail doit correspondre à un utilisateur Capgo existant.

Corps de la requête

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

Exemple de requête

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 en cas de succès

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

Notes :

• Lors de l'ajout d'un nouveau membre, celui-ci recevra un e-mail d'invitation. Son rôle sera préfixé par « invite_ » jusqu'à ce qu'il accepte l'invitation.
• L'utilisateur doit déjà avoir un compte Capgo pour pouvoir être invité. S'il n'en a pas, il doit d'abord en créer un sur https://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/

Supprime un membre d'une organisation. Cela révoquera immédiatement son 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 en cas de succès

{
  "status": "OK"
}

Gestion des erreurs

Toutes les erreurs utilisent le format d'erreur standard décrit dans la Aperçu de API.

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

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

Cas d'usage courants

1. Agrandissement de l'équipe: Ajouter de nouveaux membres de l'équipe avec les rôles appropriés
2. Contrôle d’accès: Gérer les permissions des membres selon l'évolution des responsabilités
3. Audit de sécurité: Vérifier périodiquement la liste des membres et leurs rôles
4. Restructuration de l'équipe: Mise à jour des rôles lors de changements d'organisation

Continuer depuis Membres

Si vous utilisez Membres pour planifier la sécurité et la conformité, connectez-l’à Chiffrement pour les détails d'implémentation du chiffrement, Conformité pour les détails d'implémentation de la conformité, Scanner de sécurité Capgo pour le workflow produit dans Capgo Security Scanner, Capgo et la sécurité pour le workflow produit dans Capgo Security, et Capgo Centre de confiance pour le workflow produit dans Capgo Trust Center.