Get By Query String
Introduction
This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to retrieve the user's information based on the provided Query String parameters.
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.
Comparison
Parameters
The following parameters have been deprecated.
Type
OnlyActive
SortBy
SortOrder
UsersPerPage
LookupInUserProvider
AuthSystemId
A set of new parameters has been added.
PageSize
OrderBy
OrderByType
IgnoreProvider
Note: The old model is in PascalCase, while the new model is in CamelCase.
URL
/User/{queryString}
/v4/Users/{queryString}
Method
GET
GET
Response
Get User by Query String
GET /v4/Users/{queryString}
This endpoint is used to gets the user's information from both the integration service and the subscribe registration based on the provided Query String parameters.
Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.
Path Parameters
CustomerRegistrationId*
String
Unique identifier for the user in the authentication provider.
Query Parameters
IgnoreProvider
Boolean
Indicates whether to retrieve the user details from the integration service.
EncryptedEmail
String
Encrypted email of the user
String
Email or partial email address of the user
PageSize
Integer
Maximum number of items returned per request.
Default value 10.
PageNumber
Integer
Requested page number of pagination. Default value 1.
OrderByType
Integer
Sort the records in ascending (0) or descending (1) order.
OrderBy
Integer
Sort the records based on the column number.
FirstName
String
User’s first name.
LastName
String
User’s last name.
Metadata
Dictionary <String, String>
Since it is a dictionary query parameter, each "Key-Value" pair must be sent individually with the prefix "metadata.".
For example, if the purpose is to filter users based on their first and last names, the query string will be: https://UrlBase/Users?metadata.firstName=FirstName&metadata.lastName=LastName”
Headers
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
Events
Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.
-
SUBSCRIBE_USER_GET (4000)
New event created to get User from Subscribe
Last updated