Miembros

Los miembros de la organización son usuarios que tienen acceso a su organización Capgo. Cada miembro tiene un rol específico que determina sus permisos dentro de la organización. Administrar a los miembros de manera efectiva es crucial para mantener la seguridad y la colaboración en su equipo.

Roles de Miembros

Roles Normales

• leer: Puede ver recursos pero no puede hacer cambios
• : Puede subir nuevos paquetes y ver recursossubir
• escribir: Puede modificar recursos y subir paquetes
• administrador: Puede gestionar la configuración de la organización y los miembros
• super_administrador: Tiene control total sobre la organización

Invitar Roles

• invitación de lectura pendiente: Invitación pendiente para acceso de lectura
• invitación de subida pendiente: Invitación pendiente para acceso de subida
• invite_write: Invitación pendiente para acceso de escritura
• invite_admin: Invitación pendiente para acceso de administrador
• invite_super_admin: Invitación pendiente para acceso de super administrador

Mejores Prácticas

1. Asignación de Roles: Asigne roles siguiendo el principio de privilegios mínimos
2. Auditorías Regulares: Revisar periódicamente el acceso de los miembros y eliminar cuentas no utilizadas
3. Incorporación: Tener un proceso claro para agregar nuevos miembros y asignar roles
4. Desincorporación: Eliminar con prontitud el acceso para los miembros que dejan la organización

Puntos finales

POST

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

Agregar un nuevo miembro a una organización o actualizar el rol de un miembro existente. Tenga en cuenta que solo puede invitar a usuarios que ya tienen una cuenta Capgo - el correo electrónico debe corresponder a un usuario Capgo existente.

Cuerpo de la solicitud

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

Solicitud de ejemplo

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/

Respuesta de éxito

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

Nota:

• Cuando se agrega un nuevo miembro, recibirán un correo electrónico de invitación. Su rol se prefijará con “invite_” hasta que acepten la invitación.
• El usuario debe tener ya una cuenta de Capgo antes de que puedan ser invitados. Si no tienen una cuenta, deberían crear una primero en https://console.capgo.app/register/

GET

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

Recuperar todos los miembros de una organización.

Parámetros de consulta

interface MemberQuery {
  orgId: string
}

Tipo de respuesta

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

Solicitud de ejemplo

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

Respuesta de ejemplo

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

ELIMINAR

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

Eliminar a un miembro de una organización. Esto revocará inmediatamente su acceso.

Cuerpo de la solicitud

interface MemberDelete {
  orgId: string
  email: string
}

Solicitud de ejemplo

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/

Respuesta de éxito

{
  "status": "OK"
}

Gestión de errores

Escenarios de errores comunes y sus respuestas:

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

Uso común

1. Ampliación del equipo: Agregar nuevos miembros del equipo con roles adecuados
2. Control de Acceso: Gestión de permisos de miembros según cambian las responsabilidades
3. Auditoría de Seguridad: Revisión de lista de miembros y roles periódicamente
4. Reestructuración de Equipo: Actualización de roles durante cambios organizacionales