def get_list(self, *args, **kwargs):
"""Retrieves the list of users on the site.
This includes only the users who have active accounts on the site.
Any account that has been disabled (for inactivity, spam reasons,
or anything else) will be excluded from the list.
The list of users can be filtered down using the ``q`` and
``fullname`` parameters.
Setting ``q`` to a value will by default limit the results to
usernames starting with that value. This is a case-insensitive
comparison.
If ``fullname`` is set to ``1``, the first and last names will also be
checked along with the username. ``fullname`` is ignored if ``q``
is not set.
For example, accessing ``/api/users/?q=bo&fullname=1`` will list
any users with a username, first name or last name starting with
``bo``.
"""
try:
return super(UserResource, self).get_list(*args, **kwargs)
except UserQueryError as e:
return USER_QUERY_ERROR.with_message(e.msg)
def get_list(self, *args, **kwargs):
"""Retrieves the list of users on the site.
This includes only the users who have active accounts on the site.
Any account that has been disabled (for inactivity, spam reasons,
or anything else) will be excluded from the list.
The list of users can be filtered down using the ``q`` and
``fullname`` parameters.
Setting ``q`` to a value will by default limit the results to
usernames starting with that value. This is a case-insensitive
comparison.
If ``fullname`` is set to ``1``, the first and last names will also be
checked along with the username. ``fullname`` is ignored if ``q``
is not set.
For example, accessing ``/api/users/?q=bo&fullname=1`` will list
any users with a username, first name or last name starting with
``bo``.
Inactive users will not be returned by default. However by providing
``?include-inactive=1`` they will be returned.
"""
try:
return super(UserResource, self).get_list(*args, **kwargs)
except UserQueryError as e:
return USER_QUERY_ERROR.with_message(e.msg)
