Get By Id

Introduction

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.

Comparison

Parameters

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.

User API

Users Orchestrator API

URL

/User/{customerRegistrationId}/{type}

/v4/Users/{customerRegistrationId}/?ignoreProvider={boolean}

Method

GET

Response

{
  "Code": 0,
  "Errors": [
    {
      "Message": "string",
      "Code": "string",
      "Type": {
        "Id": 0,
        "Code": "string"
      },
      "ErrorSource": "string"
    }
  ],
  "Result": {
    "User": {
      "RegistrationId": 0,
      "LoginName": "string",
      "LoginPassword": "string",
      "CustomerRegistrationId": "string",
      "EncryptedCustomerRegistrationId": "string",
      "FirstName": "string",
      "LastName": "string",
      "Email": "string",
      "Gender": "string",
      "Phone": "string",
      "MobilePhone": "string",
      "OptInEVantageSubscriberRewards": true,
      "OptInSpecialOffers": true,
      "OptInContestAndPromotions": true,
      "OptInPaperlessBilling": true,
      "OptInEEdition": true,
      "OptInEEditionEmailNotification": true,
      "OptInSubscriberDiscounts": true,
      "OptInAdvertiserEmails": true,
      "MemberEvent": true,
      "ContentEngagement": true,
      "SUBCOM": true,
      "Survey": true,
      "AccountUpdates": true,
      "DateOfBirth": "string",
      "BirthYear": "string",
      "AcceptsEmailOffers": 0,
      "AcceptsEmailAds": 0,
      "AcceptsEmailPromotions": 0,
      "IsOkToEmail": 0,
      "IsOkToPhone": 0,
      "IsOkToMail": 0,
      "AcceptsEENotification": 0,
      "ChangeDate": "2023-06-05T18:43:26.748Z",
      "DateRegistered": "2023-06-05T18:43:26.748Z",
      "AddDate": "2023-06-05T18:43:26.748Z",
      "Photos": [
        {
          "Id": "string",
          "Value": "string",
          "Type": "string"
        }
      ],
      "IsSocial": true,
      "DisplayName": "string",
      "AgreeToTerms": true,
      "OptOutMarketing": true,
      "Photo": "string",
      "VerificationCode": "string",
      "Verified": true,
      "AuthSystem": {
        "AuthSystemId": 0,
        "AuthSystemCode": "string",
        "AuthSystemName": "string"
      },
      "UserState": {
        "UserStateId": 0,
        "UserStateCode": "string"
      },
      "BounceType": "string",
      "LastLogoutDate": "2023-06-05T18:43:26.748Z",
      "UrlPasswordChangeTicket": "string",
      "Metadata": {}
    }
  },
  "SessionId": "string",
  "RequestId": "string"
}

{
    "message": {
        "code": "string",
        "text": "string",
        "type": 0
    },
    "meta": object,
    "data": {
        "customerRegistrationId": "string",
        "encryptedCustomerRegistrationId": "string",
        "email": "string",
        "verified": true,
        "loginPassword": "string",
        "lastLogoutDate": "2023-06-05T19:08:58.949Z",
        "firstName": "string",
        "lastName": "string",
        "state": UserState,
        "metadata": {
            "title": "",
            "phoneNumber": "",
            "gender": "",
            "age": "",
            "dob": "",
            "dobYYYY": "",
            "acceptsEmailOffers": "",
            "acceptsEmailAds": "",
            "acceptsEmailPromotions": "",
            "address": "",
            "city": "",
            "country": "",
            "position": "",
            "isOkToEmail": "",
            "isOkToPhone": "",
            "isOkToMail": "",
            "workPhone": "",
            "timeZone": "",
            "scoreMember": "",
            "companyName": "",
            "postalCode": "",
            "cellPhone": "",
            "acceptsEENotification": "",
            "ebill_flag": "",
            "eadvan_flag": "",
            "eedition_flag": "",
            "ee_email_flag": "",
            "promo_flag": "",
            "feat_flag": "",
            "dealdigger_flag": "",
            "ads_flag": "",
            "member_event_flag": "",
            "contentEngagement_flag": "",
            "subcom_flag": "",
            "survey_flag": "",
            "accountUpdates_flag": "",
            "photo": "",
            "displayName": "",
            "optOutMarketing": "",
            "agreeToTerms": "",
            "bounceType": "",
        ]
    },
    "addSource": "string",
    "addDate": "2023-06-05T19:08:58.949Z",
    "changeSource": "string",
    "changeDate": "2023-06-05T19:08:58.949Z"
}
}

Get User by Id

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.

Path Parameters

Name

Type

Description

CustomerRegistrationId*

String

Unique identifier for the user in the authentication provider.

Query Parameters

Name

Type

Description

IgnoreProvider

Boolean

Indicates whether to retrieve the user details from the integration service.

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

{
    "message": {
        "code": "UsersOrchestrator_S200_01",
        "text": "GetById completed.",
        "type": "Success"
    },
    "data": {
        "customerRegistrationId": "string",
        "encryptedCustomerRegistrationId": "string",
        "email": "string",
        "verified": true,
        "state": "UserStates",
        "lastLogoutDate": "Date",
        "firstName": "string",
        "lastName": "string",
        "metadata": {
            "title": "",
            "phoneNumber": "",
            "gender": "",
            "age": "",
            "dob": "",
            "dobYYYY": "",
            "acceptsEmailOffers": "",
            "acceptsEmailAds": "",
            "acceptsEmailPromotions": "",
            "address": "",
            "city": "",
            "country": "",
            "position": "",
            "isOkToEmail": "",
            "isOkToPhone": "",
            "isOkToMail": "",
            "workPhone": "",
            "timeZone": "",
            "scoreMember": "",
            "companyName": "",
            "postalCode": "",
            "cellPhone": "",
            "acceptsEENotification": "",
            "ebill_flag": "",
            "eadvan_flag": "",
            "eedition_flag": "",
            "ee_email_flag": "",
            "promo_flag": "",
            "feat_flag": "",
            "dealdigger_flag": "",
            "ads_flag": "",
            "member_event_flag": "",
            "contentEngagement_flag": "",
            "subcom_flag": "",
            "survey_flag": "",
            "accountUpdates_flag": "",
            "photo": "",
            "displayName": "",
            "optOutMarketing": "",
            "agreeToTerms": "",
            "bounceType": "",
        },
        "addDate": "Date",
        "addSource": "string",
        "changeDate": "Date",
        "changeSource": "string"
    }
}

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

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

PreviousMigration to UsersOrchestrator API NextGet By Email

Last updated 4 months ago