Platform API

<back to all web services

PasswordReset

Reset password for the specified user

The following routes are available for this service:
All Verbs/api/account/passwordreset
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Reset password for the specified user")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PasswordReset(IPublicServiceModel):
    """
    Reset password for the specified user
    """

    # @ApiMember(Description="New password for the user account", Name="NewPassword")
    new_password: Optional[str] = None
    """
    New password for the user account
    """


    # @ApiMember(Description="Confirm the new password", Name="ConfirmPassword")
    confirm_password: Optional[str] = None
    """
    Confirm the new password
    """


    # @ApiMember(Description="Password Reset Token", Name="Token")
    token: Optional[str] = None
    """
    Password Reset Token
    """


    appliance_id: Optional[str] = None
    subdomain_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PasswordResetResponse:
    response_status: Optional[ResponseStatus] = None

Python PasswordReset 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/passwordreset HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"NewPassword":"String","ConfirmPassword":"String","Token":"String","ApplianceId":"00000000-0000-0000-0000-000000000000","SubdomainName":"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"}}}