| POST | /users/forgotpassword | Forgot Password for user | Will send a restore password link to the user by the email provided. |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Enums
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
<ApiResponse(Description:="Returned if there is a validation error on the input parameters", StatusCode:=400)>
<ApiResponse(Description:="Returned if the current user is not allowed to perform the action", StatusCode:=401)>
Public Partial Class ForgotUserPassword
<ApiMember(IsRequired:=true)>
Public Overridable Property Email As String
'''<Summary>
'''The user realm for identity server. BookMore = 1, BookMoreAdmin = 2
'''</Summary>
<ApiMember(Description:="The user realm for identity server. BookMore = 1, BookMoreAdmin = 2 ", IsRequired:=true)>
Public Overridable Property Realm As KeyCloakRealm
End Class
Public Partial Class ForgotUserPasswordResponse
Public Overridable Property Email As String
Public Overridable Property ResponseStatus As Object
End Class
End Namespace
Namespace BokaMera.API.ServiceModel.Enums
Public Enum KeyCloakRealm
BookMore = 1
BookMoreAdmin = 2
SuperAdmin = 3
End Enum
End Namespace
End Namespace
VB.NET ForgotUserPassword DTOs
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.bokamera.se
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: {}
}