onadata.apps.api.viewsets.user_viewset module

Module contents

Users /users API endpoint.

class onadata.apps.api.viewsets.user_viewset.UserViewSet(**kwargs)

Bases: AuthenticateHeaderMixin, DefaultBaseViewset, CacheControlMixin, ETagsMixin, ReadOnlyModelViewSet

This endpoint allows you to list and retrieve user’s first and last names.

filter_backends = (<class 'rest_framework.filters.SearchFilter'>, <class 'onadata.libs.filters.UserNoOrganizationsFilter'>)

get_object()

Lookup a username by pk else use lookup_field

lookup_field = 'username'

lookup_value_regex = '(?:[\\w.-]+(?<!\\.json)(?<!\\.xml)(?<!\\.csv)(?<!\\.jsonp)(?<!\\.yaml)(?<!\\.html)(?<!\\.api))|\\+?[\\d.\\-]+|(?:[\\w.%+-]+@[\\w.-]+\\.[a-zA-Z]{2,}(?<!\\.json)(?<!\\.xml)(?<!\\.csv)(?<!\\.jsonp)(?<!\\.yaml)(?<!\\.html)(?<!\\.api))'

permission_classes = [<class 'onadata.apps.api.permissions.UserViewSetPermissions'>]

search_fields = ('=email', 'username')

serializer_class

alias of UserSerializer