Platform API

PasswordReset

Reset password for the specified user

The following routes are available for this service:
All Verbs	/api/account/passwordreset

"use strict";
export class PasswordReset {
    /** @param {{NewPassword?:string,ConfirmPassword?:string,Token?:string,ApplianceId?:string,SubdomainName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description New password for the user account */
    NewPassword;
    /**
     * @type {string}
     * @description Confirm the new password */
    ConfirmPassword;
    /**
     * @type {string}
     * @description Password Reset Token */
    Token;
    /** @type {string} */
    ApplianceId;
    /** @type {string} */
    SubdomainName;
}
export class PasswordResetResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}

JavaScript PasswordReset DTOs

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 /api/account/passwordreset HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NewPassword: String,
	ConfirmPassword: String,
	Token: String,
	SubdomainName: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}