starred/modoboa-modoboa
1
0
Fork 0
mirror of https://github.com/modoboa/modoboa.git synced 2026-04-26 09:26:00 +03:00
Code Issues 60 Projects Releases 10 Packages Wiki Activity

[GH-ISSUE #884] KeyError exception when altering user via API #782

New issue
Closed
opened 2026-02-27 11:13:31 +03:00 by kerem · 3 comments
kerem commented 2026-02-27 11:13:31 +03:00
Owner
Copy link

Originally created by @jficz on GitHub (Jun 2, 2016).
Original GitHub issue: https://github.com/modoboa/modoboa/issues/884

When I try to alter an account via API using API key of a SuperAdmin user (the id=1 user in fact), I get this error:

KeyError at /api/v1/accounts/2/
'role'
Request Method: PATCH
Request URL:    https://<my_domain>/api/v1/accounts/2/
Django Version: 1.9.6
Exception Type: KeyError
Exception Value:    
'role'
Exception Location: /srv/app/modoboa/env/local/lib/python2.7/site-packages/modoboa/admin/serializers.py in validate, line 189
Python Executable:  /usr/bin/uwsgi-core
Python Version: 2.7.9
Python Path:    
['.',
 '',
 '/srv/app/modoboa/env/lib/python2.7',
 '/srv/app/modoboa/env/lib/python2.7/plat-x86_64-linux-gnu',
 '/srv/app/modoboa/env/lib/python2.7/lib-tk',
 '/srv/app/modoboa/env/lib/python2.7/lib-old',
 '/srv/app/modoboa/env/lib/python2.7/lib-dynload',
 '/usr/lib/python2.7',
 '/usr/lib/python2.7/plat-x86_64-linux-gnu',
 '/usr/lib/python2.7/lib-tk',
 '/srv/app/modoboa/env/local/lib/python2.7/site-packages']
Server time:    Thu, 2 Jun 2016 21:01:30 +0000

With this stack trace:

Environment:


Request Method: PATCH
Request URL: https://<my_domain>/api/v1/accounts/2/

Django Version: 1.9.6
Python Version: 2.7.9
Installed Applications:
('django.contrib.auth',
 'django.contrib.contenttypes',
 'django.contrib.sessions',
 'django.contrib.messages',
 'django.contrib.sites',
 'django.contrib.staticfiles',
 'reversion',
 'rest_framework.authtoken',
 'rest_framework_swagger',
 'modoboa',
 'modoboa.core',
 'modoboa.lib',
 'modoboa.admin',
 'modoboa.relaydomains',
 'modoboa.limits',
 'modoboa_sievefilters',
 'modoboa_amavis',
 'modoboa_stats',
 'modoboa_postfix_autoreply',
 'modoboa_webmail')
Installed Middleware:
('x_forwarded_for.middleware.XForwardedForMiddleware',
 'django.contrib.sessions.middleware.SessionMiddleware',
 'django.middleware.common.CommonMiddleware',
 'django.middleware.csrf.CsrfViewMiddleware',
 'django.contrib.auth.middleware.AuthenticationMiddleware',
 'django.contrib.messages.middleware.MessageMiddleware',
 'django.middleware.locale.LocaleMiddleware',
 'django.middleware.clickjacking.XFrameOptionsMiddleware',
 'modoboa.lib.middleware.AjaxLoginRedirect',
 'modoboa.lib.middleware.CommonExceptionCatcher',
 'modoboa.lib.middleware.RequestCatcherMiddleware')



Traceback:

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/core/handlers/base.py" in get_response
  149.                     response = self.process_exception_by_middleware(e, request)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/core/handlers/base.py" in get_response
  147.                     response = wrapped_callback(request, *callback_args, **callback_kwargs)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/utils/decorators.py" in inner
  184.                     return func(*args, **kwargs)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/utils/decorators.py" in inner
  184.                     return func(*args, **kwargs)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/views/decorators/csrf.py" in wrapped_view
  58.         return view_func(*args, **kwargs)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/viewsets.py" in view
  87.             return self.dispatch(request, *args, **kwargs)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/views.py" in dispatch
  466.             response = self.handle_exception(exc)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/views.py" in dispatch
  463.             response = handler(request, *args, **kwargs)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/mixins.py" in partial_update
  78.         return self.update(request, *args, **kwargs)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/mixins.py" in update
  69.         serializer.is_valid(raise_exception=True)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/serializers.py" in is_valid
  213.                 self._validated_data = self.run_validation(self.initial_data)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/serializers.py" in run_validation
  410.             value = self.validate(value)

File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/modoboa/admin/serializers.py" in validate
  189.         if data["role"] == "SimpleUsers":

Exception Type: KeyError at /api/v1/accounts/2/
Exception Value: 'role'

Debian Jessie latest, barebone. Modoba installed in a virutalenv using pip install method.

Curl command used to make the api call:
curl -ik -X POST -H "Authorization: Token XXX" -d username=root -d language=cs https://<my_domain>api/v1/accounts/2/

Response header:
HTTP/1.1 500 Internal Server Error Server: nginx/1.10.1 Date: Thu, 02 Jun 2016 21:01:30 GMT Content-Type: text/html Transfer-Encoding: chunked Connection: keep-alive Vary: Accept-Language, Cookie X-Frame-Options: SAMEORIGIN Content-Language: en

I'll be more than happy to provide any additional information as needed.

Originally created by @jficz on GitHub (Jun 2, 2016). Original GitHub issue: https://github.com/modoboa/modoboa/issues/884 When I try to alter an account via API using API key of a SuperAdmin user (the id=1 user in fact), I get this error: ``` KeyError at /api/v1/accounts/2/ 'role' Request Method: PATCH Request URL: https://<my_domain>/api/v1/accounts/2/ Django Version: 1.9.6 Exception Type: KeyError Exception Value: 'role' Exception Location: /srv/app/modoboa/env/local/lib/python2.7/site-packages/modoboa/admin/serializers.py in validate, line 189 Python Executable: /usr/bin/uwsgi-core Python Version: 2.7.9 Python Path: ['.', '', '/srv/app/modoboa/env/lib/python2.7', '/srv/app/modoboa/env/lib/python2.7/plat-x86_64-linux-gnu', '/srv/app/modoboa/env/lib/python2.7/lib-tk', '/srv/app/modoboa/env/lib/python2.7/lib-old', '/srv/app/modoboa/env/lib/python2.7/lib-dynload', '/usr/lib/python2.7', '/usr/lib/python2.7/plat-x86_64-linux-gnu', '/usr/lib/python2.7/lib-tk', '/srv/app/modoboa/env/local/lib/python2.7/site-packages'] Server time: Thu, 2 Jun 2016 21:01:30 +0000 ``` With this stack trace: ``` Environment: Request Method: PATCH Request URL: https://<my_domain>/api/v1/accounts/2/ Django Version: 1.9.6 Python Version: 2.7.9 Installed Applications: ('django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.sites', 'django.contrib.staticfiles', 'reversion', 'rest_framework.authtoken', 'rest_framework_swagger', 'modoboa', 'modoboa.core', 'modoboa.lib', 'modoboa.admin', 'modoboa.relaydomains', 'modoboa.limits', 'modoboa_sievefilters', 'modoboa_amavis', 'modoboa_stats', 'modoboa_postfix_autoreply', 'modoboa_webmail') Installed Middleware: ('x_forwarded_for.middleware.XForwardedForMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.locale.LocaleMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', 'modoboa.lib.middleware.AjaxLoginRedirect', 'modoboa.lib.middleware.CommonExceptionCatcher', 'modoboa.lib.middleware.RequestCatcherMiddleware') Traceback: File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/core/handlers/base.py" in get_response 149. response = self.process_exception_by_middleware(e, request) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/core/handlers/base.py" in get_response 147. response = wrapped_callback(request, *callback_args, **callback_kwargs) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/utils/decorators.py" in inner 184. return func(*args, **kwargs) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/utils/decorators.py" in inner 184. return func(*args, **kwargs) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/django/views/decorators/csrf.py" in wrapped_view 58. return view_func(*args, **kwargs) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/viewsets.py" in view 87. return self.dispatch(request, *args, **kwargs) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/views.py" in dispatch 466. response = self.handle_exception(exc) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/views.py" in dispatch 463. response = handler(request, *args, **kwargs) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/mixins.py" in partial_update 78. return self.update(request, *args, **kwargs) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/mixins.py" in update 69. serializer.is_valid(raise_exception=True) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/serializers.py" in is_valid 213. self._validated_data = self.run_validation(self.initial_data) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/rest_framework/serializers.py" in run_validation 410. value = self.validate(value) File "/srv/app/modoboa/env/local/lib/python2.7/site-packages/modoboa/admin/serializers.py" in validate 189. if data["role"] == "SimpleUsers": Exception Type: KeyError at /api/v1/accounts/2/ Exception Value: 'role' ``` Debian Jessie latest, barebone. Modoba installed in a virutalenv using pip install method. Curl command used to make the api call: `curl -ik -X POST -H "Authorization: Token XXX" -d username=root -d language=cs https://<my_domain>api/v1/accounts/2/` Response header: `HTTP/1.1 500 Internal Server Error Server: nginx/1.10.1 Date: Thu, 02 Jun 2016 21:01:30 GMT Content-Type: text/html Transfer-Encoding: chunked Connection: keep-alive Vary: Accept-Language, Cookie X-Frame-Options: SAMEORIGIN Content-Language: en` I'll be more than happy to provide any additional information as needed.
kerem 2026-02-27 11:13:31 +03:00
  • closed this issue
  • added the
    bug
         label
kerem commented 2026-02-27 11:13:31 +03:00
Author
Owner
Copy link

@tonioo commented on GitHub (Jun 6, 2016):

@cptMikky Thanks for the feedback.

I realize I did not implement the PATCH method properly. It is provided by default (django rest framework) and I should have disabled it.

<!-- gh-comment-id:223972333 --> @tonioo commented on GitHub (Jun 6, 2016): @cptMikky Thanks for the feedback. I realize I did not implement the PATCH method properly. It is provided by default (django rest framework) and I should have disabled it.
kerem commented 2026-02-27 11:13:31 +03:00
Author
Owner
Copy link

@jficz commented on GitHub (Jun 6, 2016):

How does one alter an existing account via API then? Or am I missing something?

<!-- gh-comment-id:224013924 --> @jficz commented on GitHub (Jun 6, 2016): How does one alter an existing account via API then? Or am I missing something?
kerem commented 2026-02-27 11:13:31 +03:00
Author
Owner
Copy link

@tonioo commented on GitHub (Jun 7, 2016):

You can use the PUT method.

<!-- gh-comment-id:224193782 --> @tonioo commented on GitHub (Jun 7, 2016): You can use the PUT method.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
fix/sievefilters-allow-email-in-rule-name
dependabot/npm_and_yarn/frontend/axios-1.15.0
translations_04c0b653215cb5fa48ab101eae1a1917_ja_JP
translations_5d93982e9fd6dab991db4faf93ce9ded_ja_JP
fix/login-issue-3995
fix/sievefilters-issues
add-vitepress-openapi
2974-dmarc-empty-email
2.3.x
updated-doc-2.3.0
feature/OIDC
delete-all-alarms
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_af_ZA
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_ar
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_ca
1.x
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_sk
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_tr
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_es_ES
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_uk
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_zh_CN
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_de_DE
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_da_DK
1.8.x
1.7.x
1.6.x
1.4.x
1.3.x
1.2.x
2.8.2
2.8.1
2.8.0
2.7.2
2.7.1
2.7.0
2.6.5
2.6.4
2.6.3
2.6.2
2.6.1
2.6.0
2.5.1
2.5.0
2.4.11
2.4.10
2.4.9
2.4.8
2.4.7
2.4.6
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.6
2.3.5
2.3.4
2.3.3
2.3.2
2.3.1
2.3.0
2.3.0-beta.4
2.3.0-beta.3
2.3.0-beta.2
2.3.0-beta.1
2.2.4
2.2.3
2.2.2
2.2.1
2.2.0
2.1.2
2.1.1
2.1.0
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
2.0.0-beta.3
2.0.0-beta.2
2.0.0-beta.1
1.17.0
1.16.1
1.16.0
1.15.0
1.14.0
1.13.1
1.13.0
1.12.2
1.12.1
1.12.0
1.11.1
1.11.0
1.10.7
1.10.6
1.10.5
1.10.4
1.10.3
1.10.2
1.10.1
1.10.0
1.9.1
1.9.0
1.8.3
1.8.2
1.8.1
1.8.0
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.3
1.6.2
1.6.1
1.6.0
1.5.3
1.5.2
1.5.1
1.5.0
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.5
1.3.4
1.2.2
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.2.0-rc2
1.2.0-rc1
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.1
1.0.0
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9
0.8.8
0.8.7
0.8.6.1
0.8.6
0.8.5
0.8.4
0.8.3
0.8.3-rc1
0.8.2
0.8.1
0.8
0.8-rc2
0.8-rc1
0.7.2
0.7.1
0.7
0.6.1
0.6
0.5
0.3
0.2
0.1
Labels
Clear labels   
bug

   
bug

   
dependencies

   
design

   
documentation

   
duplicate

   
enhancement

   
enhancement

   
enhancement

   
feedback-needed

   
help-needed

   
help-needed

   
installer

   
invalid

   
looking-for-sponsors

   
modoboa-contacts

   
new-ui

   
new-ui

   
pr

   
pull-request

Mirrored from GitHub Pull Request

  
pyconfr

   
python

   
question

   
security

   
stale

   
webmail

   
wontfix
No labels
bug
bug
dependencies
design
documentation
duplicate
enhancement
enhancement
enhancement
feedback-needed
help-needed
help-needed
installer
invalid
looking-for-sponsors
modoboa-contacts
new-ui
new-ui
pr
pull-request
pyconfr
python
question
security
stale
webmail
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/modoboa-modoboa#782
No description provided.