wiki:WebAdminAPI
close Warning: Can't synchronize with repository "(default)" (/usr/local/svn/deb2-client does not appear to be a Subversion repository.). Look in the Trac log for more information.

Documentation for the DEB Web admin interface

Add/Edit? user

Request: servername/admin

POST/GET parameters:

  • login: username
  • action: edituser
  • new: set to 1 when creating new user, empty when editing existing user
  • api: 1
  • callback: JSONP callback (optional)
  • email: e-mail
  • pass: password (for new users: will generate random, if left empty)
  • name: full name (optional)
  • org: organization (optional)
  • addr: address (optional)
  • service and dictionary access
    • for each service, user should have access to, set: serv_[servicecode] to on
    • for each dictionary in service, set: dict_[servicecode]_[dictionarycode] to r (for read-only access) or w (for write access)

Response: JSON(P) encoded status message - "user created" (success), "login exists" (error, same username already exists in database)

Delete user

Request: servername/admin?action=deluser&api=1&login=username&[callback=callback]

Response: JSON(P) encoded status message - "user deleted" (success), "invalid login" (error, invalid username specified)

Reset password

Request: servername/admin?action=genpass&api=1&login=username&[callback=callback]

Response: JSON(P) encoded status message - "password reset" (success), "invalid login" (error, invalid username specified). User will receive email message with new random password.

List users

Request: servername/admin?action=listusers&api=1[&callback=callback][&detail=1][&service=service]

  • detail: display detailed information about users
  • service: filter user list by the service code

Response: JSON(P) encoded list of users (login and name), separate list for each service (with code and count) and one complete list

Last modified 11 years ago Last modified on Jul 2, 2013, 4:16:41 PM