POST | /users/forgotpassword | Forgot Password for user | Will send a restore password link to the user by the email provided. |
---|
import Foundation
import ServiceStack
// @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 class ForgotUserPassword : Codable
{
// @ApiMember(IsRequired=true)
public var email:String
/**
* The user realm for identity server. BookMore = 1, BookMoreAdmin = 2
*/
// @ApiMember(Description="The user realm for identity server. BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
public var realm:KeyCloakRealm
required public init(){}
}
public enum KeyCloakRealm : Int, Codable
{
case BookMore = 1
case BookMoreAdmin = 2
case SuperAdmin = 3
}
public class ForgotUserPasswordResponse : Codable
{
public var email:String
//responseStatus:Object ignored. Type could not be extended in Swift
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Email":"String","Realm":"BookMore"}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"Email":"String","ResponseStatus":{}}