IT4Change/gradido
3
0
Fork 0
mirror of https://github.com/IT4Change/gradido.git synced 2025-12-13 07:45:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation for reset password

Browse Source
This commit is contained in:
Ulf Gebhardt 2021-04-12 15:28:08 +02:00
parent 1d81c7e472
commit 1da150bf15
No known key found for this signature in database
GPG Key ID: 81308EFE29ABFEBD
2 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docu/README.md
View File

@ -7,6 +7,12 @@ The API Documentation is separated by which server answers them. Either the comm
- [login-server API](./login_server.api.md) - [login-server API](./login_server.api.md)
- [community-server API](./community-server.api.md) - [community-server API](./community-server.api.md)
### Process - Reset password
1. Send user email with email verification code: [Send E-Mails](https://github.com/gradido/gradido/blob/master/docu/login_server.api.md#send-e-mails)
2. Login via emailVerificationCode: [Login by Email Verification Code](https://github.com/gradido/gradido/blob/master/docu/login_server.api.md#login-by-email-verification-code)
3. change password: [Update user data](https://github.com/gradido/gradido/blob/master/docu/login_server.api.md#update-user-data)
## Graphics ## Graphics
The following Graphics try to show certain mechanics, principles and structures of the gradido project The following Graphics try to show certain mechanics, principles and structures of the gradido project

19
docu/login_server.api.md
View File

@ -139,7 +139,7 @@ with:
"User.first_name": "Max", "User.first_name": "Max",
"User.last_name" : "Musterman", "User.last_name" : "Musterman",
"User.disabled": 0, "User.disabled": 0,
"User.language": "de" "User.language": "de",
"User.password": "1234" "User.password": "1234"
} }
} }
@ -290,7 +290,8 @@ with:
```json ```json
{ {
"email": "max.musterman@gmail.de", "email": "max.musterman@gmail.de",
"email_text":7, "email_verification_code_type":"resetPassword" "email_text":7,
"email_verification_code_type":"resetPassword"
} }
``` ```
@ -299,7 +300,8 @@ also valid:
```json ```json
{ {
"email": "max.musterman@gmail.de", "email": "max.musterman@gmail.de",
"email_text":"user reset Password", "email_verification_code_type":"resetPassword" } "email_text":"user reset Password",
"email_verification_code_type":"resetPassword" }
``` ```
// TODO this makes no sense, why two fields email_text & code_type? // TODO this makes no sense, why two fields email_text & code_type?
@ -366,6 +368,17 @@ A result with `"state":"error"` and an additional `"msg"` if an error occurred (
- "invalid verification code type": could not parse email verification code type - "invalid verification code type": could not parse email verification code type
- "json exception": error parsing input json, more infos can be found in details - "json exception": error parsing input json, more infos can be found in details
### Side effects
#### For `resetPassword`:
User gets an email with a link to `http://localhost/account/checkEmail/<emailVerificationCode>`.
The link can be modified in the Login-Server config:
`frontend.checkEmailPath = http://localhost/account/checkEmail`
For the docker build, you can find the config here: `configs/login_server/grd_login.properties`
## Check Running Transactions / password encryption ## Check Running Transactions / password encryption
Check if transactions on login-server for user are processed Check if transactions on login-server for user are processed