From 5b71a86092b5f6060198fba5d267dad3f924415f Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Thu, 18 Feb 2021 16:21:06 +0100 Subject: [PATCH 1/2] login server api --- docu/login_server.api.md | 65 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 docu/login_server.api.md diff --git a/docu/login_server.api.md b/docu/login_server.api.md new file mode 100644 index 000000000..5167146e8 --- /dev/null +++ b/docu/login_server.api.md @@ -0,0 +1,65 @@ +# login server api + +Gradido js-Frontend vereinfachte Zusammenarbeit mit Login-Server und Community-Server + +Es ist mit einer Zusatz-Option möglich das Login und Registrieren via ajax-Request passiern kann. +Dafür muss in der Login-Server Config + +unsecure.allow_passwort_via_json_request = 1 + +gesetzt sein. + +In diesen Beispielen gehe ich jetzt davon aus, das du das gesamte Gradido Projekt mit Docker gebaut hast und auf dem lokalen Rechner laufen lässt. + +Login +Einloggen über: + + +# unsecureLogin + +POST http://localhost/login_api/unsecureLogin +data: {"username": "", "password": ""} + +Wenn alles okay ist erhältst du: +{"state":"success", "session_id": , "clientIP":"", + "user": { + "created": , + "disabled": , // login will fail if user is disabled + "email": "", + "email_checked": , // true if user has already clicked on email verification code link in his emails + "first_name": "", + "group_alias": "", + "ident_hash": , + "last_name": "", + "public_hex": "<64 character hex (contain only a-f and 0-9)>", + "role": "", // should be only valid for login-server + "username": "", + "balance": , // 174500 = 17,45 GDD + "id": , + "errorCount": +}} + +Anmelden +Registrieren kannst du einen neuen Benutzer mit: + + +## createUser + +POST http://localhost/login_api/createUser +data: {"email":"", "first_name":"", "last_name":"" , + "emailType": 2, "password":""} + +Wenn alles okay ist erhältst du: +{"state":"success"} + +Dann wurde für den Benutzer ein neues Konto angelegt, seine Schlüssel generiert und ihm eine Bestätigungs-Email geschickt. + + +## Logout + +Abmelden +POST http://localhost/login_api/logout +data: {"session_id": } + +Wenn alles okay ist erhältst du: +{"state":"success"} \ No newline at end of file From c90762549a18143df07cf148edf5ea3be026ffbf Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Thu, 18 Feb 2021 16:23:41 +0100 Subject: [PATCH 2/2] more style --- docu/login_server.api.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docu/login_server.api.md b/docu/login_server.api.md index 5167146e8..1342d8284 100644 --- a/docu/login_server.api.md +++ b/docu/login_server.api.md @@ -18,9 +18,12 @@ Einloggen über: # unsecureLogin POST http://localhost/login_api/unsecureLogin +``` data: {"username": "", "password": ""} +``` Wenn alles okay ist erhältst du: +``` {"state":"success", "session_id": , "clientIP":"", "user": { "created": , @@ -38,6 +41,7 @@ Wenn alles okay ist erhältst du: "id": , "errorCount": }} +``` Anmelden Registrieren kannst du einen neuen Benutzer mit: @@ -46,11 +50,15 @@ Registrieren kannst du einen neuen Benutzer mit: ## createUser POST http://localhost/login_api/createUser +``` data: {"email":"", "first_name":"", "last_name":"" , "emailType": 2, "password":""} +``` Wenn alles okay ist erhältst du: +``` {"state":"success"} +``` Dann wurde für den Benutzer ein neues Konto angelegt, seine Schlüssel generiert und ihm eine Bestätigungs-Email geschickt. @@ -59,7 +67,11 @@ Dann wurde für den Benutzer ein neues Konto angelegt, seine Schlüssel generier Abmelden POST http://localhost/login_api/logout +``` data: {"session_id": } +``` Wenn alles okay ist erhältst du: -{"state":"success"} \ No newline at end of file +``` +{"state":"success"} +``` \ No newline at end of file