Revision 1ae97c83 docs/source/devguide.rst

b/docs/source/devguide.rst
12 12
* Twitter
13 13
* Shibboleth
14 14

  
15
It provides also an administrative interface for managing user accounts.
15
It provides also a command line tool for managing user accounts.
16 16

  
17 17
It is build over django and extends its authentication mechanism.
18 18

  
......
102 102
* send feedback for grnet services via: ``/im/send_feedback``
103 103
* logout (and delete cookie) via: ``/im/logout``
104 104

  
105
User entries can also be modified/added via the administrative interface available at ``/im/admin``.
105
User entries can also be modified/added via the ``snf-manage activateuser`` command.
106 106

  
107 107
A superuser account can be created the first time you run the ``manage.py syncdb`` django command and then loading the extra user data from the ``admin_user`` fixture. At a later date, the ``manage.py createsuperuser`` command line utility can be used (as long as the extra user data for Astakos is added with a fixture or by hand).
108 108

  
......
126 126
The Astakos API
127 127
---------------
128 128

  
129
All API requests require a token. An application that wishes to connect to Astakos, but does not have a token, should redirect the user to ``/login``. (see :ref:`authentication-label`)
130

  
131 129
.. _authenticate-api-label:
132 130

  
133 131
Authenticate
134 132
^^^^^^^^^^^^
135 133

  
134
Authenticate API requests require a token. An application that wishes to connect to Astakos, but does not have a token, should redirect the user to ``/login``. (see :ref:`authentication-label`)
135

  
136 136
==================== =========  ==================
137
Uri                                  Method     Description
137
Uri                  Method     Description
138 138
==================== =========  ==================
139 139
``/im/authenticate`` GET        Authenticate user using token
140 140
==================== =========  ==================
......
179 179
401 (Unauthorized)          Missing token or inactive user
180 180
500 (Internal Server Error) The request cannot be completed because of an internal error
181 181
=========================== =====================
182

  
183
Get Services
184
^^^^^^^^^^^^
185

  
186
Returns a json formatted list containing information about the supported cloud services.
187

  
188
==================== =========  ==================
189
Uri                  Method     Description
190
==================== =========  ==================
191
``/im/get_services`` GET        Get cloud services
192
==================== =========  ==================
193

  
194
Example reply:
195

  
196
::
197

  
198
[{"url": "/", "icon": "home-icon.png", "name": "grnet cloud", "id": "cloud"},
199
 {"url": "/okeanos.html", "name": "~okeanos", "id": "okeanos"},
200
 {"url": "/ui/", "name": "pithos+", "id": "pithos"}]
201
 
202
Get Menu
203
^^^^^^^^
204

  
205
Returns a json formatted list containing the cloud bar links. 
206

  
207
==================== =========  ==================
208
Uri                  Method     Description
209
==================== =========  ==================
210
``/im/get_menu``     GET        Get cloud bar menu
211
==================== =========  ==================
212

  
213
Example reply if request user is not authenticated:
214

  
215
::
216

  
217
[{"url": "/im/login?next=", "name": "login..."}]
218

  
219
Example reply if request user is authenticated:
220

  
221
[{"url": "/im/profile", "name": "spapagian@grnet.gr"},
222
 {"url": "/im/profile", "name": "view your profile..."},
223
 {"url": "/im/password", "name": "change your password..."},
224
 {"url": "/im/feedback", "name": "feedback..."},
225
 {"url": "/im/logout", "name": "logout..."}]
226

  
227

  
228

  
229

  

Also available in: Unified diff