summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-05-08 15:11:09 +0530
committerFlorian Dold <florian.dold@gmail.com>2020-05-08 15:11:09 +0530
commitaf572ded501cc77a2ac89bae27a9bf7d19cc9739 (patch)
treee91658fe37d9034f335c902be9c41f71b5a17dbb /libeufin
parenta92981f37ddca8903e4f72359a22a6ff699546dd (diff)
downloaddocs-af572ded501cc77a2ac89bae27a9bf7d19cc9739.tar.gz
docs-af572ded501cc77a2ac89bae27a9bf7d19cc9739.tar.bz2
docs-af572ded501cc77a2ac89bae27a9bf7d19cc9739.zip
user API
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-nexus2.rst33
1 files changed, 27 insertions, 6 deletions
diff --git a/libeufin/api-nexus2.rst b/libeufin/api-nexus2.rst
index af940dec..3609b0e0 100644
--- a/libeufin/api-nexus2.rst
+++ b/libeufin/api-nexus2.rst
@@ -7,12 +7,33 @@ HTTP API
Authentication
--------------
-**Every** request made to nexus must be authenticated
-using the *HTTP basic auth* mechanism.
+Currently every request made to nexus must be authenticated using the *HTTP
+basic auth* mechanism.
+
+Other authentication mechanisms (e.g. OpenID Connect) might
+be supported in the future.
Users Management
----------------
+.. http:get:: <nexus>/user
+
+ Get information about the current user (based on the authentication information
+ in this request).
+
+ **Response:**
+
+ .. ts:def:: GetUserResponse
+
+ interface UserResponse {
+
+ // User name
+ username: string;
+
+ // Is it a superuser?
+ superuser: boolean;
+ }
+
.. http:post:: <nexus>/users
Create a new user. Only the super-user can call this API.
@@ -27,15 +48,15 @@ Users Management
**Details:**
- .. ts:def:: User
+ .. ts:def:: CreateUserRequest
interface User {
// User name
username: string;
- // Shadow password
- shadowPassword: string;
+ // Initial password
+ password: string;
}
Bank Account Management
@@ -164,7 +185,7 @@ Bank Account Management
interface CollectTransactions {
// Optional field to specify the bank transport to
// use for such operation.
- bankTransport: string;
+ bankTransport?: string;
// dashed date (YYYY-MM-DD) of the earliest payment
// in the result. Optional, defaults to "earliest
// possible" date.