onadata.apps.api.viewsets.connect_viewset module

Module contents

The /api/v1/user API implementation

User authentication API support to access API tokens.

class onadata.apps.api.viewsets.connect_viewset.ConnectViewSet(**kwargs)

Bases: CreateModelMixin, AuthenticateHeaderMixin, CacheControlMixin, ETagsMixin, ObjectLookupMixin, GenericViewSet

This endpoint allows you retrieve the authenticated user’s profile info.

create(request, *args, **kwargs)

expire(request, *args, **kwargs)

Implements the /expire endpoint

Allows a user to expire a TempToken.

list(request, *args, **kwargs)

Implements the List endpoint - returns authentication tokens for current user.

lookup_field = 'user'

odk_token(request, *args, **kwargs)

Implements the /odk_token endpoint

Allows a user to get or create or expire an ODKToken for use with ODK Collect.

permission_classes = (<class 'onadata.apps.api.permissions.ConnectViewsetPermissions'>,)

queryset

regenerate_auth_token(request, *args, **kwargs)

Implements the /regenerate_auth_token endpoint

Allows a user to expire and create a new API Token.

reset(request, *args, **kwargs)

Implements the /reset endpoint

Allows a user to reset and change their password.

serializer_class

alias of UserProfileWithTokenSerializer

starred(request, *args, **kwargs)

Return projects starred for this user.

onadata.apps.api.viewsets.connect_viewset.user_profile_w_token_response(request, status_code)

Returns authenticated user profile