> For the complete documentation index, see [llms.txt](https://docs.navigaglobal.com/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.navigaglobal.com/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api.md).

# Migration to UsersOrchestrator API

## **Introduction** <a href="#migrationfromusertousersorchestrator-intro" id="migrationfromusertousersorchestrator-intro"></a>

This section outlines the process to be followed in order to migrate from the old UserAPI endpoints to the new UsersOrchestratorAPI endpoints. This section also shows a comparison of the old and new APIs.

The endpoints covered in this section are as listed below:

1. [Get By Id](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/get-by-id.md)
2. [Get By Email](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/get-by-email.md)
3. [Get By Query String](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/get-by-query-string.md)
4. [Get By Encrypted Email](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/get-by-encrypted-email.md)
5. [Get By Encrypted Id](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/get-by-encrypted-id.md)
6. [Get By Token](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/get-by-token.md)
7. [Create User](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/create-user.md)
8. [Create Passwordless User](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/create-passwordless-user.md)
9. [Update User](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/update-user.md)
10. [Update Password](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/update-password.md)
11. [Update Email](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/update-email.md)
12. [Authenticate / Authenticate By Token](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/authenticate-authenticate-by-token.md)
13. [ForgotPassword](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/forgotpassword.md)
    1. [ForgotPassword (Start)](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/forgotpassword.md#forgotpassword-start)
    2. [ForgotPassword (Validity)](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/forgotpassword.md#forgotpassword-validate)
    3. [ForgotPassword (Finish)](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/forgotpassword.md#forgotpassword-finish)
14. [Verify Email](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/verify-email.md)
15. [Send Verification Code](/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api/send-verification-code.md)

{% hint style="danger" %}

## **ProxyAPI Information** <a href="#migrationfromentitlementstoentitlementsorchestrator-proxyapiinformation-important" id="migrationfromentitlementstoentitlementsorchestrator-proxyapiinformation-important"></a>

In order to redirect to UserAPI or to UsersOrchestratorAPI, ProxyAPI must have the following settings in place:

* MG2 Control Internal setting, **UsersOrchestrator** - Its value includes a "string.Format" that must be utilized to determine the correct API route. The value by default is "*{0}/UsersOrchestrator*".

**Note:** *Since the ProxyAPI directly calls the UsersOrchestratorAPI, GatewayAPI is not involved in the request chain.*
{% endhint %}

{% hint style="success" %}
**IgnoreProvider Considerations**

* This flag is included in the Body or QueryString of certain endpoints.
* This parameter is used to retrieve only SubscribeRegistration results while ignoring third-party integration services. This is an optional parameter that modifies the workflow execution.
  {% endhint %}

## **User States** <a href="#migrationfromusertousersorchestrator-userstates" id="migrationfromusertousersorchestrator-userstates"></a>

The UserOrchestrator API also includes the registration status in the API response.

1. The `GET /Users` and `GET /Users/id` endpoints will include the output parameter, **State**, which returns the status of a registration.
   * The registration's status will be returned as follows:
     * If the tenant has been associated with a third-party authentication system such as Auth0, Firefly, etc., the State will be returned as <mark style="color:purple;">**Standard**</mark>.
     * If the tenant has been associated with MG2 Auth:
       * When the *Password* field in the database remains blank, the State will be <mark style="color:purple;">**Lite**</mark>.
       * When the *Verified* field in the database has been set to False, the State will be <mark style="color:purple;">**Unverified**</mark>.
       * When the *Password* field hasn't been blank and the *Verified* field has been set to true, the State will be <mark style="color:purple;">**Standard**</mark>.
2. The `POST /Users` endpoint will display an error when trying to create a registration that already exists in the database and has the <mark style="color:purple;">**Verified**</mark> field set to false.
3. The `POST /Users/Authentication` endpoint will display an error when trying to login with an <mark style="color:purple;">**Unverified**</mark> or <mark style="color:purple;">**Lite**</mark> registration.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.navigaglobal.com/naviga-subscribe-api/MhIk9TtEtuSKzip2tsSt/users-orchestrator-api/migration-to-usersorchestrator-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.