documentation for reset password

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

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)
- [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
The following Graphics try to show certain mechanics, principles and structures of the gradido project

View File

@ -139,7 +139,7 @@ with:
"User.first_name": "Max",
"User.last_name" : "Musterman",
"User.disabled": 0,
"User.language": "de"
"User.language": "de",
"User.password": "1234"
}
}
@ -289,8 +289,9 @@ with:
```json
{
"email": "max.musterman@gmail.de",
"email_text":7, "email_verification_code_type":"resetPassword"
"email": "max.musterman@gmail.de",
"email_text":7,
"email_verification_code_type":"resetPassword"
}
```
@ -299,7 +300,8 @@ also valid:
```json
{
"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?
@ -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
- "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 if transactions on login-server for user are processed