ForgotPassword

ForgotPassword (Start)

Introduction

This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and the Subscribe Registration API to create the STARTFORGOTPASSWORD (PWDREQ) event and send an email with a link to the subscriber.

Comparison

Note:

1. The old model is in PascalCase, while the new model is in CamelCase.

2. UsersOrchestrator API doesn’t return PasswordResetLinkSent.

	User API	Users Orchestrator API
URL	/ForgotPassword	/v4/Users/ForgotPassword
Method	POST	POST
Request	{ "LoginName": "string", "ReturnUrl": "string" }	{ "loginName": "string", "returnUrl": "string" }
Response	{ "Code": 0, "Errors": [ { "Message": "string", "Code": "string", "Type": { "Id": 0, "Code": "string" }, "ErrorSource": "string" } ], "Result": { "PasswordResetLinkSent": true }, "SessionId": "string", "RequestId": "string" }	{ "message": { "code": "string", "text": "string", "type": 0 }, "meta": {}, "data": { "encryptedEventId": "string" } }

ForgotPassword (Start)

POST /v4/Users/ForgotPassword

This endpoint is used to create the STARTFORGOTPASSWORD (PWDREQ) event and send an email with a link to the subscriber.

Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.

Headers

Name	Type	Description
Authorization*	String	JSON Web Token used for security purposes
X-SourceSystem*	String	To identify the consumer or the Source System
X-ClientCode*	String	Client Code of the Tenant
X-PaperCode*	String	Paper Code of the Tenant
X-ClientGroupCode*	String	Client Group Code of the Tenant

Request Body

Name	Type	Description
ReturnUrl	String	URL to which users must be redirected after they have successfully verified their registration.
LoginName*	String	Subscriber’s login name.

200

{
  "message":{
      "code": "UsersOrchestrator_S200_08",
      "text": "Start ForgotPassword completed.",
      "type": "Success"
  },
  "data": {
    "encryptedEventId": string
  },
  "meta": null
}

Error Codes

Status Code	Code	Message
400	UsersOrchestrator_E400	Bad Request
400	UsersOrchestrator_E400_00	Invalid InputModel - {Message}
500	UsersOrchestrator_E500	Internal Server Error

Events

Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.

Current	New	Note
PWDREQ (64)	SUBSCRIBE_USER_STARTFORGOTPASSWORD (4009)	The new event is used to Start forgot password in Subscribe

---

ForgotPassword (Validate)

Introduction

This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and the Subscribe Registration API to validate whether the received EncryptedEventId is a valid event for the forgot password flow.

Comparison

Note:

1. The old model is in PascalCase, while the new model is in CamelCase.

2. The UsersOrchestrator API returns the EventId associated with the user.

3. If the event is invalid, the UsersOrchestrator API returns an error.

	User API	Users Orchestrator API
URL	/ForgotPassword/Validity	/v4/Users/ForgotPassword/{{EncryptedEventId}}/Validity
Method	POST	GET
Request	{ "EncryptedEventId": "string" }
Response	{ "Code": 0, "Errors": [ { "Message": "string", "Code": "string", "Type": { "Id": 0, "Code": "string" }, "ErrorSource": "string" } ], "Result": { "IsValid": true }, "SessionId": "string", "RequestId": "string" }	{ "message": { "code": "string", "text": "string", "type": 0 }, "meta": {}, "data": { "eventId": 0 } }

Forgot Password (Validate)

GET /v4/Users/ForgotPassword/{{EncryptedEventId}}/Validity

This endpoint is used to validate whether the received EncryptedEventId is a valid event for the forgot password flow.

Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.

Path Parameters

Name	Type	Description
EncryptedEventId*	String	Encrypted unique identifier of the event.

Headers

Name	Type	Description
Authorization*	String	JSON Web Token used for security purposes
X-SourceSystem*	String	To identify the consumer or the Source System
X-ClientCode*	String	Client Code of the Tenant
X-PaperCode*	String	Paper Code of the Tenant
X-ClientGroupCode*	String	Client Group Code of the Tenant

200

{
  "message":{
      "code": "UsersOrchestrator_S200_09",
      "text": "Validate ForgotPassword completed.",
      "type": "Success"
  },
  "data": {
   "eventId": int
  }
  meta: null
}

Error Codes

Status Code	Code	Message
400	UsersOrchestrator_E400	Bad Request
400	UsersOrchestrator_E400_00	Invalid InputModel - {Message}
500	UsersOrchestrator_E500	Internal Server Error

---

ForgotPassword (FINISH)

Introduction

This endpoint receives the new password to set based on an event and triggers the UpdatePassword workflow.

Comparison

Note:

1. The old model is in PascalCase, while the new model is in CamelCase.

2. If the flow fails, the UsersOrchestrator API returns an error.

	User API	Users Orchestrator API
URL	/ForgotPassword/ChangePassword	/v4/Users/ForgotPassword/{{EncryptedEventId}}
Method	POST	POST
Request	{ "EncryptedEventId": "string", "NewPassword": "string" }	{ "password": :"string" }
Response	{ "Code": 0, "Errors": [ { "Message": "string", "Code": "string", "Type": { "Id": 0, "Code": "string" }, "ErrorSource": "string" } ], "Result": { "Done": true }, "SessionId": "string", "RequestId": "string" }	{ "message": { "code": "string", "text": "string", "type": 0 }, "meta": {} }

ForgotPassword (Finish)

POST /v4/Users/ForgotPassword/{{EncryptedEventId}}

This endpoint receives the new password to set based on an event and triggers the UpdatePassword workflow.

Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.

Path Parameters

Name	Type	Description
EncryptedEventId*	String	Encrypted unique identifier of the event.

Headers

Name	Type	Description
Authorization*	String	JSON Web Token used for security purposes
X-SourceSystem*	String	To identify the consumer or the Source System
X-ClientCode*	String	Client Code of the Tenant
X-PaperCode*	String	Paper Code of the Tenant
X-ClientGroupCode*	String	Client Group Code of the Tenant

Request Body

Name	Type	Description
Password*	String	Subscriber’s password.

200: OK Success Response

{
  "message":{
      "code": "UsersOrchestrator_S200_10",
      "text": "Finish ForgotPassword completed.",
      "type": "Success"
  },
  "meta": null
}

400: Bad Request Bad Request

Error Code: UsersOrchestrator_E400

Error Message: Bad Request

400: Bad Request Invalid InputModel

Error Code: UsersOrchestrator_E400_02

Error Message: Invalid InputModel

500: Internal Server Error Internal Server Error

Error Code: UsersOrchestrator_E500

Error Message: Internal Server Error

Events

Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.

Current	New	Note
CHGPWD (22)	AUTHSYSTEM_USER_CHANGEPASSWORD (4609) SUBSCRIBE_USER_CHANGEPASSWORD (4010)	For each CHGPWD old event, we now create two events: one for the call to the third-party system and one for the call to our database.