Saltar al contenido

Usuarios

Miembros del equipo en tu espacio de trabajo — sus roles, estado y asignaciones de nodos del organigrama. Los hashes de contraseña, secretos TOTP y datos de sesión nunca se devuelven.

GET/api/v1/users

Lista paginada de usuarios en tu organización.

Parámetros de consulta

NombreTipoObligatorioDescripción
limitintegeropcionalNúmero de resultados (predeterminado 100, máximo 500).
cursorISO 8601opcionalCursor de paginación de nextCursor.
rolestringopcionalFiltrar por rol: admin | editor | viewer
statusstringopcionalFiltrar por estado: pending | active | rejected | suspended

Valores desconocidos de role o status devuelven 400 Bad Request con un array allowed que lista los valores aceptados.

Ejemplo de respuesta

Json
{
  "data": [
    {
      "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "name": "Alice Johnson",
      "email": "alice@acme.com",
      "role": "admin",
      "status": "active",
      "assignedNodeId": "550e8400-e29b-41d4-a716-446655440000",
      "emailVerifiedAt": "2025-03-01T13:00:00.000Z",
      "createdAt": "2025-03-01T12:30:00.000Z"
    },
    {
      "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "name": "Bob Smith",
      "email": "bob@acme.com",
      "role": "editor",
      "status": "active",
      "assignedNodeId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "emailVerifiedAt": "2025-03-02T09:00:00.000Z",
      "createdAt": "2025-03-02T08:45:00.000Z"
    }
  ],
  "nextCursor": null
}

Objeto usuario

Campos

NombreTipoObligatorioDescripción
iduuidopcionalID único del usuario.
namestringopcionalNombre mostrado.
emailstringopcionalDirección de correo.
rolestringopcionaladmin | editor | viewer
statusstringopcionalpending | active | rejected | suspended
assignedNodeIduuid | nullopcionalEl nodo del organigrama al que está anclado este usuario.
emailVerifiedAtISO 8601 | nullopcionalCuándo el usuario verificó su correo. null = no verificado.
createdAtISO 8601opcionalCuándo se creó el usuario.

Campos nunca devueltos: passwordHash, totpSecret, notificationPrefs.

Ejemplos de código

# Todos los usuarios
curl "https://sopflow.io/api/v1/users" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

# Solo administradores activos
curl "https://sopflow.io/api/v1/users?role=admin&status=active" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

Administración de usuarios

Las claves API no pueden cambiar roles, estados ni nodos asignados. Un administrador con sesión iniciada debe realizar estos cambios en la interfaz de administración. El endpoint anterior PATCH /api/v1/users/:id está deshabilitado para claves API y devuelve 403 con el código human_admin_required para una clave de escritura válida.

Conciliar usuarios sin suponer permisos

Usa el identificador documentado para relacionar un usuario conocido. Revisa estado y función antes de actualizar y envía solo campos necesarios.

Cambiar función o estado afecta el acceso. Confirma persona y autoridad resultante; asignar un nodo no sustituye comprobar autorización.