Miembros

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

Roles de los miembros

Roles estándar

• lectura: Puede ver los recursos, pero no puede hacer cambios
• subida: Puede subir nuevos bundles y ver los recursos
• escribir: Puede modificar recursos y subir bundles
• adminPuede gestionar la configuración de la organización y los miembros
• super_admin: Tiene control total sobre la organización

Roles de invitación

• leer_invitaciones: Invitación pendiente con acceso de lectura
• invitar_subida: Invitación pendiente con acceso de subida
• invite_write: Invitación pendiente de acceso de escritura
• invitar_admin: Invitación pendiente de acceso de admin
• invitar_super_admin: Invitación pendiente de acceso de super admin

Buenas prácticas

1. Asignación de roles: Aplica el principio de mínimo privilegio al asignar roles
2. Auditorías periódicas: Revisa periódicamente el acceso de miembros y elimina cuentas inactivas
3. Onboarding: Ten un proceso claro para añadir nuevos miembros y asignar roles
4. Offboarding: Elimina rápidamente el acceso de los miembros que dejen la organización

Endpoints

POST

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

Añade un nuevo miembro a una organización o actualiza el rol de un miembro existente. Ten en cuenta que solo puedes invitar a usuarios que ya tengan una cuenta de Capgo; el email debe coincidir con un usuario de Capgo existente.

Cuerpo de la solicitud

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

Ejemplo de solicitud

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 exitosa

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

Notas:

• Al añadir un nuevo miembro, recibirá un email de invitación. Su rol tendrá el prefijo “invite_” hasta que acepte la invitación.
• El usuario ya debe tener una cuenta de Capgo para poder ser invitado. Si no tiene cuenta, primero debe crear una en https://capgo.app/register/

GET

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

Obtén 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";
}

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Elimina a un miembro de una organización. Esto revocará su acceso de inmediato.

Cuerpo de la solicitud

interface MemberDelete {
  orgId: string
  email: string
}

Ejemplo de solicitud

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 exitosa

{
  "status": "OK"
}

Manejo de errores

Todos los errores utilizan el formato estándar descrito en la visión general de API.

Escenarios de error comunes y sus respuestas:

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

Casos de uso comunes

1. Expansión del equipo: Añadir nuevos miembros con los roles adecuados
2. Control de acceso: Gestionar permisos según cambien las responsabilidades
3. Auditoría de seguridad: Revisar la lista de miembros y roles periódicamente
4. Reestructuración del equipo: Actualizar roles durante cambios organizativos

Continúa desde Members

Si estás usando Miembros para planificar la seguridad y el cumplimiento, conéctalo con Cifrado para los detalles de implementación en Cifrado, Cumplimiento para los detalles de implementación en Cumplimiento, Escáner de seguridad de Capgo para el flujo de trabajo del producto en Capgo Security Scanner, Seguridad de Capgo para el flujo de trabajo del producto en Capgo Security, y Centro de confianza de Capgo para el flujo de trabajo del producto en Capgo Trust Center.