From c8c1ed7b095be798f459cd75a18d0dc249068ca6 Mon Sep 17 00:00:00 2001
From: cash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Fri, 12 Feb 2010 13:24:19 +0000
Subject: updated documentation on the REST API user authentication

git-svn-id: http://code.elgg.org/elgg/trunk@3933 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/lib/api.php | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'engine')

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
-- 
cgit v1.2.3