Skip to Content
Last modified by christoph_lechleitner@iteg_at on 2013-02-02 05.47:41
From version 4.1
edited by christoph_lechleitner@iteg_at
on 2012-11-08 06.51:11
Change comment: There is no comment for this version
To version 2.1
edited by christoph_lechleitner@iteg_at
on 2012-09-21 12.40:24
Change comment: Completed operation list

Summary

Details

Page properties
Content
... ... @@ -57,55 +57,15 @@
57 57  * (% style="color: rgb(0,0,0);" %)a short message for logging (not more than 1024 bytes)
58 58  * (% style="color: rgb(0,0,0);" %)or a list of values separated by '{{code language="none"}},{{/code}}'
59 59  * (% style="color: rgb(0,0,0);" %)or '{{code language="none"}}-{{/code}}' for "empty list"/"no data"
60 -* (% style="color: rgb(0,0,0);" %)or '{{code language="none"}}--{{/code}}' for "not supported by backend"
60 +* (% style="color: rgb(0,0,0);" %)or '{{code language="none"}}–-{{/code}}' for "not supported by backend"
61 61  
62 62  The server may enforce the use of HTTP basic authentication in order to keep offending servers away from dictionary attacks.
63 63  
64 -===== {{id name="HTTPauthenticationAPING-JSONvariant"/}}JSON variant =====
65 -
66 -A backend may support to return the response in the form of small JSON documents.
67 -
68 -To trigger json response, add the parameter {{code language="none"}}json=1{{/code}} to the request, like this:
69 -
70 -{{code}}
71 -POST /my/authentication/service HTTP/1.1
72 -Host: auth.my.domain
73 -Content-Type: application/x-www-form-urlencoded
74 -
75 -op=<op>&json=1&param1=<value1>&param2=<value2>
76 -{{/code}}
77 -
78 -To explicitly disable JSON response, use {{code language="none"}}json=0{{/code}} instead.
79 -
80 -Backends might choose to support only one variant, only with or only without JSON response.
81 -
82 -With JSON reponses on, the repsonse is either
83 -
84 -(% style="list-style-type: square;" %)
85 -* (((
86 -a short message, like
87 -
88 -{{code language="none"}}
89 -{ "message" : "Some message to use in log files" }
90 -{{/code}}
91 -)))
92 -* (% style="color: rgb(0,0,0);" %)or a list of named values, for examples scroll down to the operation chapters
93 -* (% style="color: rgb(0,0,0);" %)or a empty list if no data can be found
94 -* (((
95 -(% style="color: rgb(0,0,0);" %)or an error message for "not supported by backend" or similar problems, like
96 -
97 -{{code language="none"}}
98 -{ "error" : "Operation not supported by backend for specified domain" }
99 -{{/code}}
100 -
101 -(% style="color: rgb(0,0,0);" %)\\
102 -)))
103 -
104 104  == {{id name="HTTPauthenticationAPING-Requiredoperations"/}}Required operations ==
105 105  
106 106  ==== {{id name="HTTPauthenticationAPING-tryLogin"/}}tryLogin ====
107 107  
108 -====== {{id name="HTTPauthenticationAPING-Requestbody(newformat,preferred)"/}}Request body (new format, preferred) ======
68 +Request body (new format, preferred):
109 109  
110 110  {{code}}
111 111  op=tryLogin&user=<user>&domain=<domain>&passwd=<passwd>
... ... @@ -114,25 +114,25 @@
114 114  
115 115  The {{code language="none"}}domain{{/code}} parameter is optional.
116 116  
117 -====== {{id name="HTTPauthenticationAPING-Requestbodyinoldformat,supportedforbackwardcompatibilityreasons"/}}Request body in old format, supported for backward compatibility reasons ======
77 +Request body in old format, supported for backward compatibility reasons:
118 118  
119 119  {{code}}
120 120  user=<user>&passwd=<passwd>
121 121  {{/code}}
122 122  
123 -====== {{id name="HTTPauthenticationAPING-Responsebody"/}}Response body ======
83 +Response body:
124 124  
125 -(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)Non-empty information text, not more (% style="color: rgb(0,0,0);" %)than 1024 bytes. The message may go into logfiles and should not be displayed to the user.
85 +(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)Non-empty information text, not more (% style="color: rgb(0,0,0);" %)than 1024 bytes. The message may go into logfiles and should not be displayed to the user.
126 126  
127 127  ==== {{id name="HTTPauthenticationAPING-getSupportedOperations"/}}getSupportedOperations ====
128 128  
129 -====== {{id name="HTTPauthenticationAPING-Requestbody"/}}Request body ======
89 +Request body (new format, preferred):
130 130  
131 131  {{code}}
132 132  op=getSupportedFeatures
133 133  {{/code}}
134 134  
135 -====== {{id name="HTTPauthenticationAPING-Responsebody(plainnon-JSONvariant)"/}}Response body (plain non-JSON variant)(% style="color: rgb(0,0,0);" %) (%%) ======
95 +Response body:(% style="color: rgb(0,0,0);" %)
136 136  
137 137  (% style="color: rgb(0,0,0);" %)List of suppored operations, separated by '{{code language="none"}},{{/code}}'.
138 138  
... ... @@ -148,12 +148,6 @@
148 148  getSupportedOperations,tryLogin,changePassword,deactivateUser,getDefaultDomain,getGroups,sendPassword,searchUser
149 149  {{/code}}
150 150  
151 -====== {{id name="HTTPauthenticationAPING-Responsebody(JSONvariant)"/}}Response body (JSON variant) ======
152 -
153 -{{code language="none"}}
154 -{ "operations": [ "getSupportedOperations", "tryLogin" ] }
155 -{{/code}}
156 -
157 157  == {{id name="HTTPauthenticationAPING-OptionalOperations"/}}(% style="color: rgb(0,0,0);" %)Optional Operations(%%) ==
158 158  
159 159  ==== {{id name="HTTPauthenticationAPING-changePassword"/}}changePassword ====
... ... @@ -160,7 +160,7 @@
160 160  
161 161  Changes the password of the user.
162 162  
163 -====== {{id name="HTTPauthenticationAPING-Requestbody"/}}Request body ======
117 +Request body:
164 164  
165 165  {{code}}
166 166  op=changePassword&user=<user>&domain=<domain>&oldPassword=<oldPassword>&newPassword=<newPassword>&newPasswordConfirmed=<newPassword>
... ... @@ -171,7 +171,7 @@
171 171  
172 172  The {{code language="none"}}newPasswordConfirmed{{/code}} parameter is optional and available only to simplify writing web interfaces. If it is specified and does not match {{code language="none"}}newPassword{{/code}}, the password is not changed.
173 173  
174 -====== {{id name="HTTPauthenticationAPING-Responsebody"/}}Response body ======
128 +Response body:
175 175  
176 176  (% style="color: rgb(0,0,0);" %)Non-empty information text, not more than 1024 bytes. The message may go into logfiles and should not be displayed to the user.
177 177  
... ... @@ -179,7 +179,7 @@
179 179  
180 180  Deactivates a user, prevents him for logging in again.
181 181  
182 -====== {{id name="HTTPauthenticationAPING-Requestbody"/}}Request body ======
136 +Request body:
183 183  
184 184  {{code}}
185 185  op=deactivateUser&user=<user>&domain=<domain>
... ... @@ -187,7 +187,7 @@
187 187  
188 188  The {{code language="none"}}domain{{/code}} parameter is optional.
189 189  
190 -====== {{id name="HTTPauthenticationAPING-Responsebody"/}}Response body ======
144 +Response body:
191 191  
192 192  (% style="color: rgb(0,0,0);" %)Non-empty information text, not more than 1024 bytes. The message may go into logfiles and should not be displayed to the user.
193 193  
... ... @@ -195,7 +195,7 @@
195 195  
196 196  Returns the default domain, if there is any.
197 197  
198 -====== {{id name="HTTPauthenticationAPING-Requestbody"/}}Request body ======
152 +Request body (new format, preferred):
199 199  
200 200  {{code}}
201 201  op=getDefaultDomain
... ... @@ -202,46 +202,24 @@
202 202  
203 203  {{/code}}
204 204  
205 -====== {{id name="HTTPauthenticationAPING-Responsebody(plainnon-JSONvariant)"/}}Response body(% style="color: rgb(0,0,0);" %) (plain non-JSON variant) (%%) ======
159 +Response body:(% style="color: rgb(0,0,0);" %)
206 206  
207 207  Default authentication domain, or '{{code language="none"}}-{{/code}}' if there is no default domain, or '{{code language="none"}}--{{/code}}' if there is no domain support at all.
208 208  
209 -====== {{id name="HTTPauthenticationAPING-Responsebody(JSONvariant)"/}}Response body (JSON variant) ======
210 -
211 -{{code language="none"}}
212 -{ "defaultDomain": [ "SOMEDOMAIN" ] }
213 -{{/code}}
214 -
215 215  ==== {{id name="HTTPauthenticationAPING-getGroups"/}}getGroups ====
216 216  
217 217  Returns the groups the user is a member of.
218 218  
219 -====== {{id name="HTTPauthenticationAPING-Requestbody"/}}Request body ======
167 +Request body:
220 220  
221 221  {{code}}
222 -op=getGroups&user=<user>&domain=<domain>
170 +op=searchUser&user=<user>&domain=<domain>
223 223  {{/code}}
224 224  
225 225  The {{code language="none"}}domain{{/code}} parameter is optional.
226 226  
227 -====== {{id name="HTTPauthenticationAPING-Responsebody(plainnon-JSONvariant)"/}}(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)Response body (plain non-JSON variant)(%%) ======
175 +Response body:
228 228  
229 -(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %) (% style="color: rgb(0,0,0);" %)List of group names, separated by '(% style="color: rgb(0,0,0);" %){{code language="none"}},{{/code}}' or just '(% style="color: rgb(0,0,0);" %){{code language="none"}}-{{/code}}' if the user is not member of any group, or '(% style="color: rgb(0,0,0);" %){{code language="none"}}--{{/code}}' if there is no group support.
230 -
231 -==== {{id name="HTTPauthenticationAPING-getGroupMembers"/}}getGroupMembers ====
232 -
233 -Returns the users the are a member of the specified group.
234 -
235 -====== {{id name="HTTPauthenticationAPING-Requestbody"/}}Request body ======
236 -
237 -{{code}}
238 -op=getGroupMembers&group=<group>&domain=<domain>
239 -{{/code}}
240 -
241 -The {{code language="none"}}domain{{/code}} parameter is optional.
242 -
243 -====== {{id name="HTTPauthenticationAPING-Responsebody(plainnon-JSONvariant)"/}}(% style="color: rgb(0,0,0);" %)Response body (plain non-JSON variant)(%%) ======
244 -
245 245  (% style="color: rgb(0,0,0);" %)List of group names, separated by '{{code language="none"}},{{/code}}' or just '{{code language="none"}}-{{/code}}' if the user is not member of any group, or '{{code language="none"}}--{{/code}}' if there is no group support.
246 246  
247 247  ==== {{id name="HTTPauthenticationAPING-sendPassword"/}}sendPassword ====
... ... @@ -248,7 +248,7 @@
248 248  
249 249  Generates a new password or send a "new password" link to the user.
250 250  
251 -====== {{id name="HTTPauthenticationAPING-Requestbody"/}}Request body ======
183 +Request body:
252 252  
253 253  {{code}}
254 254  op=sendPassword&user=<user>&domain=<domain>
... ... @@ -257,7 +257,7 @@
257 257  
258 258  The {{code language="none"}}domain{{/code}} parameter is optional.
259 259  
260 -====== {{id name="HTTPauthenticationAPING-Responsebody"/}}Response body ======
192 +Response body:
261 261  
262 262  (% style="color: rgb(0,0,0);" %)Non-empty information text, not more than 1024 bytes. The message may go into logfiles and should not be displayed to the user.
263 263  
... ... @@ -265,7 +265,7 @@
265 265  
266 266  Searches a user in the database, sets response code to 200 if the user is there, 404 if the user could not be found.
267 267  
268 -====== {{id name="HTTPauthenticationAPING-Requestbody"/}}Request body ======
200 +Request body:
269 269  
270 270  {{code}}
271 271  op=searchUser&user=<user>&domain=<domain>
... ... @@ -273,7 +273,7 @@
273 273  
274 274  The {{code language="none"}}domain{{/code}} parameter is optional.
275 275  
276 -====== {{id name="HTTPauthenticationAPING-Responsebody"/}}Response body ======
208 +Response body:
277 277  
278 278  (% style="color: rgb(0,0,0);" %)Non-empty information text, not more than 1024 bytes. The message may go into logfiles and should not be displayed to the user.
279 279  
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -688875
1 +688675
URL
... ... @@ -1,1 +1,1 @@
1 -https://clazzes.atlassian.net/wiki/spaces/LOGIN/pages/688875/HTTP authentication API NG
1 +https://clazzes.atlassian.net/wiki/spaces/LOGIN/pages/688675/HTTP authentication API NG