Related Documents
Document Properties
Kbid2V5473
Last Modified14-Sep-2018
Added to KB09-Jan-2014
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Request password reminder e-mail


Note

Starting with 7.10 our REST API is documented using Swagger notation accessible at developer.cloud.intershop.com.

URI

/security/reminder

Http Method

POST

Short Description

Valid data submitted to this resource will trigger a password reminder process by sending an e-mail.

Query Parameters

none

Example Requests

/security/reminder

HTTP Status Codes

200 OK

400 Bad Request

Possible values for header value error-key:

  • account.forgotdata.email.login.invalid.error
  • account.forgotdata.name.invalid.error
  • account.forgotdata.security_answer.invalid.error

500 Internal Server Error

Description

If the client submits a login e-mail address, first and last name and the answer to the security question set during the registration then an e-mail will be sent to the customer, or customer's user, containing a link to reset their password.

This feature depends on correctly configured preferences for "Forgotten password" functionality.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.credentials.PasswordReminderResource
com.intershop.sellside.rest.common.capi.resourceobject.PasswordReminderRO

Request Example

{
      "email" : "goosen@test.intershop.de",
      "firstName": "Gerhardt",
      "lastName": "Goosen",
      "answer" : "Unknown"
}

Response Data Format

Response related java object

n/a

Response Example

n/a

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.common.capi.resource.credentials.PasswordReminderResource
com.intershop.sellside.rest.common.capi.resourceobject.PasswordReminderRO

XML Request Example

<PasswordReminder>
    <answer>Unknown</answer>
    <email>pmiller@test.intershop.de</email>
    <firstName>Patricia</firstName>
    <lastName>Miller</lastName>
</PasswordReminder>

XML Response Data Format

XML Response Java Objects

n/a

XML Response Example

n/a

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets