[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: user API
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: user API |
Date: |
Fri, 08 May 2020 11:41:15 +0200 |
This is an automated email from the git hooks/post-receive script.
dold pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new af572de user API
af572de is described below
commit af572ded501cc77a2ac89bae27a9bf7d19cc9739
Author: Florian Dold <address@hidden>
AuthorDate: Fri May 8 15:11:09 2020 +0530
user API
---
libeufin/api-nexus2.rst | 33 +++++++++++++++++++++++++++------
1 file changed, 27 insertions(+), 6 deletions(-)
diff --git a/libeufin/api-nexus2.rst b/libeufin/api-nexus2.rst
index af940de..3609b0e 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.
--
To stop receiving notification emails like this one, please contact
address@hidden.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: user API,
gnunet <=