BokaMera.API.Host

<back to all web services

ForgotUserPassword

The following routes are available for this service:
POST/users/forgotpasswordForgot Password for userWill send a restore password link to the user by the email provided.
ForgotUserPassword Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringYes
RealmbodyKeyCloakRealmYesThe user realm for identity server. BookMore = 1, BookMoreAdmin = 2
KeyCloakRealm Enum:
NameValue
BookMore1
BookMoreAdmin2
SuperAdmin3
ForgotUserPasswordResponse Parameters:
NameParameterData TypeRequiredDescription
EmailformstringYes
ResponseStatusformObjectYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: {}
}