This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API.
With the input parameter Customer Registration ID (CRID), the API gets the user's information from both the integration service and the subscribe registration. The response displays the combined information.
Based on the value of Flow.UserProvider and the IgnoreProvider input parameter, the API gives user information in the following way:
If no valid value is provided in Flow.UserProvider, the API retrieves user information from the Subscribe Registration API.
If a valid value is provided in Flow.UserProvider and the input parameter IgnoreProvider is set to True, the API retrieves user information from the Subscribe Registration API.
If a valid value is provided in Flow.UserProvider and the input parameter IgnoreProvider is set to False, the user's details are retrieved from both the integration service and the subscribe registration. The combined information is displayed in the response.
Note
MG2 control flow setting: Flow.UserProvider value should be set to "Auth0," "Gigya," "SSOR", or "Firefly", depending on the third-party system or integration service being used.
MG2 control flow setting, "Flow.Users.RedirectToOrchestrator", value has to be set to 1 for the ProxyAPI redirection to the UsersOrchestratorAPI instead of the UserAPI.
The parameter, Type, has been deprecated.
A new parameter, IgnoreProvider, has been added.
Note: The old model is in PascalCase, while the new model is in CamelCase.
URL
/User/{customerRegistrationId}/{type}
/v4/Users/{customerRegistrationId}/?ignoreProvider={boolean}
Method
GET
GET
Response
GET /v4/Users/{customerRegistrationId}/?ignoreProvider={boolean}
This endpoint is used to gets the user's information from both the integration service and the subscribe registration based on the CustomerRegistrationId.
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.
IgnoreProvider
Boolean
Indicates whether to retrieve the user details from the integration service.
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
Error Code: UsersOrchestrator_E400 Error Message: Bad Request
Error Code: UsersOrchestrator_E400_01
Error Message: Invalid Id
Error Code: UsersOrchestrator_E500 Error Message: Internal Server Error
Error Code: UsersOrchestrator_E500_01
Error Message: 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.
CREATELOGIN (68)
-
No user will be created but synchronized in our database
GETUSERBYID (1042)
AUTHSYSTEM_USER_GETBYID (4601)
Renamed.
This event retrieves a User by Id from AuthSystem.
-
SUBSCRIBE_USER_GETBYID (4001)
New event created to get User By Id from Subscribe
-
SUBSCRIBE_USER_UPDATE (4004)
New event created to update User in Subscribe