This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to update a user based on the provided CustomerRegistrationId.
The old model is in PascalCase, while the new model is in CamelCase.
Cookie tokens will not be returned by the UsersOrchestrator API.
For custom fields, use Metadata.
URL
/User/{customerRegistrationId}
/v4/Users/{customerRegistrationId}/
Method
PUT
PUT
Request
Response
PUT /v4/Users/{customerRegistrationId}/
This endpoint is used to update 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
Metadata
Object
Metadata must be an object in camelCase format.
LastName
String
Subscriber’s last name.
FirstName
String
Subscriber’s first name.
IgnoreProvider
Boolean
If the IgnoreProvider flag is false, it executes a Create operation through the ThirdParty system (Integration).
If the IgnoreProvider flag is true, it executes a Create operation through the SubscribeRegistration API (Subscribe).
Verified
Boolean
Indicates whether the user has confirmed the registration.
LastLogoutDate
DateTime
Subscriber’s last logout date in the Naviga platform.
RemoveLastLogoutDate
Boolean
Indicates whether to remove the Subscriber’s last logout date.
400
UsersOrchestrator_E400
Bad Request
400
UsersOrchestrator_E400_00
Invalid InputModel - {Message}
400
UsersOrchestrator_E400_22
There was an error trying to update the user.
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.
UPDATEUSER (712)
AUTHSYSTEM_USER_CREATE (4602)
SUBSCRIBE_USER_CREATE (4002)
For each UPDATEUSER old event, we now create two events: one for the call to the third-party system and one for the call to our database.