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

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

    public ApplianceId: string;
    public SubdomainName: string;
    public SuiteId: string;
    /** @description Appliance Url for the appliance */
    // @ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")
    public ApplianceLoginUrl: string;

    public constructor(init?: Partial<GetResetPasswordToken>) { (Object as any).assign(this, init); }
}

export class GetResetPasswordTokenResponse
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetResetPasswordTokenResponse>) { (Object as any).assign(this, init); }
}

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