aboutsummaryrefslogtreecommitdiff
path: root/engine/lib
diff options
context:
space:
mode:
authorcash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-02-12 13:24:19 +0000
committercash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-02-12 13:24:19 +0000
commitc8c1ed7b095be798f459cd75a18d0dc249068ca6 (patch)
treed9e022bacbcbbb3884da04e069fc14cec48f1207 /engine/lib
parent00aba1bbcc50f1190c5694791d58276f96188cff (diff)
downloadelgg-c8c1ed7b095be798f459cd75a18d0dc249068ca6.tar.gz
elgg-c8c1ed7b095be798f459cd75a18d0dc249068ca6.tar.bz2
updated documentation on the REST API user authentication
git-svn-id: http://code.elgg.org/elgg/trunk@3933 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/lib')
-rw-r--r--engine/lib/api.php3
1 files changed, 2 insertions, 1 deletions
diff --git a/engine/lib/api.php b/engine/lib/api.php
index 4fd474de7..ffb1e16af 100644
--- a/engine/lib/api.php
+++ b/engine/lib/api.php
@@ -1342,7 +1342,8 @@ function list_all_apis() {
/**
* The auth.gettoken API.
* This API call lets a user log in, returning an authentication token which can be used
- * to authenticate a user for a period of time.
+ * to authenticate a user for a period of time. It is passed in future calls as the parameter
+ * auth_token.
*
* @param string $username Username
* @param string $password Clear text password