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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Generate password reset token and send email
    ///</summary>
    [<Api(Description="Generate password reset token and send email")>]
    [<AllowNullLiteral>]
    type GetResetPasswordToken() = 
        ///<summary>
        ///Get password reset token for the specified user name
        ///</summary>
        [<ApiMember(Description="Get password reset token for the specified user name", Name="UserName")>]
        member val UserName:String = null with get,set

        member val ApplianceId:Guid = new Guid() with get,set
        member val SubdomainName:String = null with get,set
        member val SuiteId:Guid = new Guid() with get,set
        ///<summary>
        ///Appliance Url for the appliance
        ///</summary>
        [<ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")>]
        member val ApplianceLoginUrl:String = null with get,set

    [<AllowNullLiteral>]
    type GetResetPasswordTokenResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

F# 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"}}}