Platform API

<back to all web services

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.*


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

    override var ApplianceId:UUID? = null
    override var SubdomainName:String? = null
    open var SuiteId:UUID? = null
    /**
    * Appliance Url for the appliance
    */
    @ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")
    open var ApplianceLoginUrl:String? = null
}

open class GetResetPasswordTokenResponse
{
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin GetResetPasswordToken DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"UserName":"String","ApplianceId":"00000000-0000-0000-0000-000000000000","SubdomainName":"String","SuiteId":"00000000-0000-0000-0000-000000000000","ApplianceLoginUrl":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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