From 63a286147685073102270f4974d85b32818641c5 Mon Sep 17 00:00:00 2001
From: jf-guillou <jean-francois.guillou@univ-rennes1.fr>
Date: Mon, 25 Jan 2016 10:05:44 +0100
Subject: Added API getUserByName()

Tests and doc included
---
 doc/api-user-procedures.markdown | 42 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

(limited to 'doc')

diff --git a/doc/api-user-procedures.markdown b/doc/api-user-procedures.markdown
index 6ecf12c6..9b43e1e1 100644
--- a/doc/api-user-procedures.markdown
+++ b/doc/api-user-procedures.markdown
@@ -113,6 +113,48 @@ Response example:
 }
 ```
 
+## getUserByName
+
+- Purpose: **Get user information**
+- Parameters:
+    - **username** (string, required)
+- Result on success: **user properties**
+- Result on failure: **null**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getUserByName",
+    "id": 1769674782,
+    "params": {
+        "username": "biloute"
+    }
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 1769674782,
+    "result": {
+        "id": "1",
+        "username": "biloute",
+        "password": "$2y$10$dRs6pPoBu935RpmsrhmbjevJH5MgZ7Kr9QrnVINwwyZ3.MOwqg.0m",
+        "role": "app-user",
+        "is_ldap_user": "0",
+        "name": "",
+        "email": "",
+        "google_id": null,
+        "github_id": null,
+        "notifications_enabled": "0"
+    }
+}
+```
+
 ## getAllUsers
 
 - Purpose: **Get all available users**
-- 
cgit v1.2.3