This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to create a user.
The old model is in PascalCase, while the new model is in CamelCase.
Cookie tokens will not be returned by the UsersOrchestrator API.
For custom fields, use Metadata.
URL
/User
/v4/Users
Method
POST
POST
Request
Response
POST /v4/Users
This endpoint is used to create a user.
Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.
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
String
Subscriber’s email.
Metadata
Object
Metadata must be an object in camelCase format.
LastName
String
Subscriber’s last name.
FirstName
String
Subscriber’s first name.
IgnoreProvider
Boolean
If the IgnoreProvider flag is false, it executes a Create operation through the ThirdParty system (Integration).
If the IgnoreProvider flag is true, it executes a Create operation through the SubscribeRegistration API (Subscribe).
ReturnUrl
String
URL to which users must be redirected after they have successfully verified their registration.
VerifyEmail
Boolean
Default false.
If True is provided, then the registration will not be created right away. Naviga would wait until the user confirmed the registration by clicking the link in the verification email.
Password
String
Subscriber’s password.
EncryptedCustomerRegistrationid
String
Encrypted unique identifier for the user in authentication system.
CustomerRegistrationId
String
Unique identifier for the user in the authentication provider
400
UsersOrchestrator_E400
Bad Request
400
UsersOrchestrator_E400_00
Invalid InputModel - {Message}
400
UsersOrchestrator_E400_07
The entered email address is still pending for verification.
400
UsersOrchestrator_E400_08
The email is already in use by another user.
400
UsersOrchestrator_E400_09
The metadata is invalid.
400
UsersOrchestrator_E400_17
Metadata Key or Value cannot contain more than 100 characters.
400
UsersOrchestrator_E400_23
The customer registration id already exists.
500
UsersOrchestrator_E500
Internal Server Error
500
UsersOrchestrator_E500_01
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.
GETUSER (73)
AUTHSYSTEM_USER_GET (4601)
Renamed.
This event retrieves a User by Id from AuthSystem.
CREATELOGIN (68)
AUTHSYSTEM_USER_CREATE (4602)
SUBSCRIBE_USER_CREATE (4002)
For each CREATELOGIN old event, we now create two events. One is for the call to the third-party system, and the other is for the call to our database.
SUBSCRIBE_USER_CREATE is responsible for sending the email.