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 Foundation
import ServiceStack

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

    public var applianceId:String
    public var subdomainName:String
    public var suiteId:String
    /**
    * Appliance Url for the appliance
    */
    // @ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")
    public var applianceLoginUrl:String

    required public init(){}
}

public class GetResetPasswordTokenResponse : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}


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

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