| POST | /users/forgotpassword | Forgot Password for user | Will send a restore password link to the user by the email provided. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| body | string | Yes | ||
| Realm | body | KeyCloakRealm | Yes | The user realm for identity server. BookMore = 1, BookMoreAdmin = 2 |
| Name | Value | |
|---|---|---|
| BookMore | 1 | |
| BookMoreAdmin | 2 | |
| SuperAdmin | 3 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| form | string | Yes | ||
| ResponseStatus | form | Object | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/forgotpassword HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Email: String,
Realm: BookMore
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Email: String,
ResponseStatus: {}
}