Naviga Subscribe API
Naviga
  • Subscribe API
  • Payments API
    • Migration to Payments API
      • Apply Payment
      • EZPay Sign Up
      • Update EZPay Info
      • Restart
      • Create Payment Method
      • Get Payment Method by Id
      • Add Tip
  • Users Orchestrator API
    • Migration to UsersOrchestrator API
      • Get By Id
      • Get By Email
      • Get By Query String
      • Get By Encrypted Email
      • Get By Encrypted Id
      • Get By Token
      • Create User
      • Create Passwordless User
      • Update User
      • Update Password
      • Update Email
      • Authenticate/Authenticate By Token
      • ForgotPassword
      • Verify Email
      • Send Verification Code
  • Entitlements Orchestrator API
    • Migration to EntitlementsOrchestrator API
      • Access
Powered by GitBook
LogoLogo

COPYRIGHT © 2024 NAVIGA

On this page
  • Introduction
  • Comparison
  • Update Password
  • Events
Export as PDF
  1. Users Orchestrator API
  2. Migration to UsersOrchestrator API

Update Password

Introduction

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.

Comparison

Note: The old model is in PascalCase, while the new model is in CamelCase.

User API
Users Orchestrator API

URL

/User/{customerRegistrationId}

/v4/Users/{CustomerRegistrationId}/Password

Method

PUT

PATCH

Request

Response


Update Password

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.

Path Parameters

Name
Type
Description

CustomerRegistrationId*

String

Unique identifier for the user in the authentication provider

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

Request Body

Name
Type
Description

Password*

String

Subscriber’s password.

{
  "message":{
      "code": "UsersOrchestrator_S200_11",
      "text": "Update password completed.",
      "type": "Success"
  },
  meta: null
}
Status Code
Code
Message

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.

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

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.

PreviousUpdate UserNextUpdate Email

Last updated 9 months ago

{
  "OldPassword": "string",
  "Password": "string"
}
{
  "password": "string"
}
{
  "Code": 0,
  "Errors": [
    {
      "Message": "string",
      "Code": "string",
      "Type": {
        "Id": 0,
        "Code": "string"
      },
      "ErrorSource": "string"
    }
  ],
  "Result": {
    "CustomerRegistrationId": "string",
    "Updated": true
  },
  "SessionId": "string",
  "RequestId": "string"
}
{
  "message": {
    "code": "string",
    "text": "string",
    "type": 0
  },
  "meta": "string"