Add New User to an Existing OrganizationAdmin Scope
You can add an end-user to an existing organization without creating a new organization for them. This can be done by providing the OrgID of the organization that the user must be added to. The organization of a user cannot be changed later, once it is associated with their account.
When the user has signed up, unique identification values such as ZUID and User ID are created for them.
-
You must provide the values for the mandatory parameters, OrgID, email_id and first_name, to register a user.
-
You can also add end-users to your application by providing the role_id from the Roles section in Authentication in the Catalyst console.
-
When inviting a new user, you can configure the sender’s email address, subject and the email message. You must add the email address in the Catalyst Mail Component and get it verified before using it in the SDK code.
Create a JSON Configuration
Before you add a new end-user to your Catalyst application, you must create a JSON object that contains the registration details of a particular user as shown below. You can then pass the configuration to the user registration method.
//Create a JSON object for adding a new user to an existing org
const signupConfig = {
platform_type: 'web',
template_details: {
senders_mail: 'dogogetu@tutuapp.bid',
subject: 'Welcome to %APP_NAME% ',
message: '<p>Hello ,</p> <p>Follow this link to join in %APP_NAME% .</p> <p><a href=\'%LINK%\'>%LINK%</a></p> <p>If you didn\'t ask to join the application, you can ignore this email.</p> <p>Thanks,</p> <p>Your %APP_NAME% team</p>'
}
};
var userConfig = {
first_name: 'Amelia',
last_name: 'Burrows',
email_id: 'emma@zylker.com',
org_id: 10014774358
};SDK Method to Add to Existing Org
You can now add a new end-user to an existing organization by passing the JSON objects you created in the previous section as arguments to the addUserToOrg() SDK method. This method handles the user sign-up process and returns a promise. This promise will be resolved to a JSON object.
The userManagement reference used in the code snippet below is the component instance.
//Pass the JSON configurations to the method
const addedUser = await userManagement.addUserToOrg(signupConfig, userConfig);
console.log(addedUser);Example of Expected Response
{
"zaid": "1005634498",
"user_details": {
"zuid": "1005643749",
"org_id": "10014774358",
"status": "ACTIVE",
"is_confirmed": false,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"created_time": "Aug 12, 2021 03:56 PM",
"modified_time": "Aug 12, 2021 03:56 PM",
"invited_time": "Aug 12, 2021 03:56 PM",
"role_details": {
"role_name": "App User",
"role_id": "2305000000006024"
},
"user_type": "App User",
"user_id": "2305000000009002",
"project_profiles": []
},
"redirect_url": "https://aliencity-66446133.development.catalystserverless.com/app/",
"platform_type": "web",
"org_id": null
}Last Updated 2026-07-02 14:51:41 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us