Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Use the following endpoint to generate a password reset code for the specified user (accountId). 

Info

NOTE: An email is sent to the listed email address only if an SMTP email server has been configured for the

D s platform
to use. See Enable SMTP Email Server Integration.

Endpointhttp://www.example.com:3005/v4/passwordresetrequest
AuthenticationRequired
MethodPOST
Request Body


Code Block
{
  "accountId": 6,
  "email": "joe@example.com",
  "orginURL": "http://loginpage.example.com:3005/"
}


Response Status Code201 - Created
Response Body


Code Block
{
    "code": "<AccountResetURL><AccountResetCode>",
    "email": "joe@example.com"
}


The above must be built into a URL in the following format:

Code Block
<http|https>://<host_name>:<port_number>/password-reset?email=<user_id>&code=<AccountResetCode>


URL elementExample valueDescription
<http|https>
httpHTTP protocol type
<host_name>
loginpage.example.com

Host of the

D s webapp

<port_number>
3005

Port number used to login to the

D s webapp

<user_id>
joe@example.comUser ID (email address) of the user whose password is to be reset
<AccountResetCode>
CD44232791Password reset code


Reference Docs:

API Password Reset Request Create v4

...

Reference Docs:

API People Delete v4