aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/api.php
diff options
context:
space:
mode:
Diffstat (limited to 'engine/lib/api.php')
-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