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.
"use strict";
export class ForgotUserPasswordResponse {
    /** @param {{Email?:string,ResponseStatus?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Email;
    /** @type {Object} */
    ResponseStatus;
}
/** @typedef {number} */
export var KeyCloakRealm;
(function (KeyCloakRealm) {
    KeyCloakRealm[KeyCloakRealm["BookMore"] = 1] = "BookMore"
    KeyCloakRealm[KeyCloakRealm["BookMoreAdmin"] = 2] = "BookMoreAdmin"
    KeyCloakRealm[KeyCloakRealm["SuperAdmin"] = 3] = "SuperAdmin"
})(KeyCloakRealm || (KeyCloakRealm = {}));
export class ForgotUserPassword {
    /** @param {{Email?:string,Realm?:KeyCloakRealm}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Email;
    /**
     * @type {KeyCloakRealm}
     * @description The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2  */
    Realm;
}

JavaScript ForgotUserPassword DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ForgotUserPassword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Email>String</Email>
  <Realm>BookMore</Realm>
</ForgotUserPassword>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ForgotUserPasswordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Email>String</Email>
  <ResponseStatus />
</ForgotUserPasswordResponse>