Platform API

GetResetPasswordToken

Generate password reset token and send email

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

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Generate password reset token and send email
    */
    @Api(Description="Generate password reset token and send email")
    public static class GetResetPasswordToken implements IPublicServiceModel
    {
        /**
        * Get password reset token for the specified user name
        */
        @ApiMember(Description="Get password reset token for the specified user name", Name="UserName")
        public String UserName = null;

        public UUID ApplianceId = null;
        public String SubdomainName = null;
        public UUID SuiteId = null;
        /**
        * Appliance Url for the appliance
        */
        @ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")
        public String ApplianceLoginUrl = null;
        
        public String getUserName() { return UserName; }
        public GetResetPasswordToken setUserName(String value) { this.UserName = value; return this; }
        public UUID getApplianceId() { return ApplianceId; }
        public GetResetPasswordToken setApplianceId(UUID value) { this.ApplianceId = value; return this; }
        public String getSubdomainName() { return SubdomainName; }
        public GetResetPasswordToken setSubdomainName(String value) { this.SubdomainName = value; return this; }
        public UUID getSuiteId() { return SuiteId; }
        public GetResetPasswordToken setSuiteId(UUID value) { this.SuiteId = value; return this; }
        public String getApplianceLoginUrl() { return ApplianceLoginUrl; }
        public GetResetPasswordToken setApplianceLoginUrl(String value) { this.ApplianceLoginUrl = value; return this; }
    }

    public static class GetResetPasswordTokenResponse
    {
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetResetPasswordTokenResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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
		}
	}
}