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.

export class ForgotUserPasswordResponse
{
    public Email: string;
    public ResponseStatus: Object;

    public constructor(init?: Partial<ForgotUserPasswordResponse>) { (Object as any).assign(this, init); }
}

export enum KeyCloakRealm
{
    BookMore = 1,
    BookMoreAdmin = 2,
    SuperAdmin = 3,
}

// @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)
export class ForgotUserPassword
{
    // @ApiMember(IsRequired=true)
    public Email: string;

    /** @description 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 Realm: KeyCloakRealm;

    public constructor(init?: Partial<ForgotUserPassword>) { (Object as any).assign(this, init); }
}

TypeScript ForgotUserPassword DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"Email":"String","Realm":"BookMore"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Email":"String","ResponseStatus":{}}