Platform API

GetResetPasswordToken

Generate password reset token and send email

The following routes are available for this service:
All Verbs	/api/account/{UserName}/passwordresettoken

"use strict";
export class GetResetPasswordToken {
    /** @param {{UserName?:string,ApplianceId?:string,SubdomainName?:string,SuiteId?:string,ApplianceLoginUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Get password reset token for the specified user name */
    UserName;
    /** @type {string} */
    ApplianceId;
    /** @type {string} */
    SubdomainName;
    /** @type {string} */
    SuiteId;
    /**
     * @type {string}
     * @description Appliance Url for the appliance */
    ApplianceLoginUrl;
}
export class GetResetPasswordTokenResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}

JavaScript GetResetPasswordToken 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/{UserName}/passwordresettoken HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserName: String,
	SubdomainName: String,
	ApplianceLoginUrl: 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
		}
	}
}