This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to update the password of a user based on the provided CustomerRegistrationId.
Note: The old model is in PascalCase, while the new model is in CamelCase.
URL
/User/{customerRegistrationId}
/v4/Users/{CustomerRegistrationId}/Password
Method
PUT
PATCH
Request
Response
PATCH /Users/{{customerRegistrationId}}/Password
This endpoint is used to update the password of a user.
Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.
CustomerRegistrationId*
String
Unique identifier for the user in the authentication provider
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
Password*
String
Subscriber’s password.
400
UsersOrchestrator_E400
Bad Request
400
UsersOrchestrator_E400_00
Invalid InputModel - {Message}
500
UsersOrchestrator_E500
Internal Server Error
500
UsersOrchestrator_E500_01
There was a problem during the GetById workflow.
Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.
GETUSERBYID (1042)
AUTHSYSTEM_USER_GETBYID (4601)
SUBSCRIBE_USER_GETBYID (4001)
For each GETUSERBYID old event, we now create two events: one for the call to the third-party system and one for the call to our database.
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. SUBSCRIBE_USER_CHANGEPASSWORD is responsible for sending the email.