MembershipProvidersServices.ResetPassword Method

MembershipProvidersServicesResetPassword Method

Ingeniux CMS Web Services API

Resets an integrated User's password on its Membership Provider. Also, an email is sent to target user to provide the temporary password.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<ResetPasswordOutput> ResetPassword(
	string providerName,
	string userName
)

Public Function ResetPassword ( 
	providerName As String,
	userName As String
) As XHRServiceResponseGeneric(Of ResetPasswordOutput)

public:
virtual XHRServiceResponseGeneric<ResetPasswordOutput^>^ ResetPassword(
	String^ providerName, 
	String^ userName
) sealed

abstract ResetPassword : 
        providerName : string * 
        userName : string -> XHRServiceResponseGeneric<ResetPasswordOutput> 
override ResetPassword : 
        providerName : string * 
        userName : string -> XHRServiceResponseGeneric<ResetPasswordOutput>

Parameters

providerName: Type: SystemString
Name of the Membership Provider for given user
userName: Type: SystemString
User Name (Id)

Return Value

Type: XHRServiceResponseGenericResetPasswordOutput

The password reset status

Examples

Sample JSON return - Email successful

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "EmailError": null,
        "EmailSent": true,
        "ErrorCode": null,
        "ErrorMessage": null,
        "Newpassword": null,
        "ResetSuccessful": true
    }
}

Examples

Sample JSON return - Email failed, this will include email error and return the new password.

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "EmailError": "The parameter 'from' cannot be an empty string.\u000d\u000aParameter name: from",,
        "EmailSent": true,
        "ErrorCode": null,
        "ErrorMessage": null,
        "Newpassword": "letmein",
        "ResetSuccessful": true
    }
}

Reference

MembershipProvidersServices Class

IngeniuxCMService Namespace