Members

Les 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. La gestion efficace des membres est cruciale pour maintenir la sécurité et la collaboration au sein de votre équipe.

Rôles des membres

Rôles réguliers

lire : peut afficher les ressources mais ne peut pas apporter de modifications
télécharger : peut télécharger de nouveaux bundles et afficher les ressources
écrire : peut modifier les ressources et télécharger des bundles
admin : peut gérer les paramètres et les membres de l’organisation
super_admin : a un contrôle total sur l’organisation

Inviter des rôles

invite_read : invitation en attente pour un accès en lecture
invite_upload : invitation en attente pour l’accès au téléchargement
invite_write : invitation en attente pour un accès en écriture
invite_admin : invitation en attente pour l’accès administrateur
invite_super_admin : invitation en attente pour un accès super-administrateur

## meilleures pratiques

Attribution des rôles : suivez le principe du moindre privilège lors de l’attribution des rôles
Audits réguliers : examinez périodiquement l’accès des membres et supprimez les comptes inutilisés
Intégration : disposez d’un processus clair pour ajouter de nouveaux membres et attribuer des rôles
Désintégration : supprimez rapidement l’accès aux membres qui quittent l’organisation.

Points de terminaison

POSTER

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 ne pouvez inviter que des utilisateurs qui possèdent déjà un compte Capgo - l’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 réussie

{
  "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, celui-ci recevra un email d’invitation. Leur rôle sera préfixé par « invite_ » jusqu’à ce qu’ils acceptent l’invitation.
L’utilisateur doit déjà disposer d’un compte Capgo avant de pouvoir être invité. S’ils n’ont pas de compte, ils doivent d’abord en créer un sur https://console.capgo.app/register/.

OBTENIR

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 demande

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 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 réussie

{
  "status": "OK"
}

Gestion des erreurs

Scénarios d’erreur 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"
}

Cas d’utilisation courants

Expansion de l’équipe : ajout de nouveaux membres de l’équipe avec les rôles appropriés
Contrôle d’accès : gestion des autorisations des membres à mesure que les responsabilités changent
Audit de sécurité : examen périodique de la liste des membres et des rôles
Restructuration de l’équipe : mise à jour des rôles lors des changements organisationnels