Users

Users

 

Authentication and User Basics

You must remember the following important details about Catalyst Authentication and Users:

  • An end-user can be added in your application in three ways:
    1. The application developer or a collaborator of the Catalyst project can add a new user from Authentication in the Catalyst console, or using Java, Node.js, Web SDKs or the API. When the user clicks on the URL in the invite email, it will open a default sign-up form where they can set up their password. After they set up their password, they will either be redirected to the default redirect URL of the application or the URL you specify while inviting the user from the console.
    2. You can distribute the URL of your application to the user through other mediums and enable them to sign-up for it through the application's sign-up page. The same process as above is followed.
    3. You can enable provisions for a user to be added by another existing user of the application with the necessary privileges, such as a user of the role App admin. You can incorporate this feature in your application's logic.
     
    Note: You will be able to add only 25 users in your application in the development environment. After you deploy your application to production, you can include any number of end-users in it.
  • ZUID: ZUID is the unique identification of a Zoho user account for each individual application. It is automatically created for an end-user when they sign-up for your application.
  • UserID: UserID is the unique identification of an end-user, limited to Catalyst alone and not applicable to other Zoho services. This is also automatically created for an end-user when they sign-up for your application.
  • ZAAID or orgID: ZAAID or orgID is the unique identification of the organization that an end-user belongs to. This identification is generated only when a user is added through the Add User API. They are automatically assigned to an organization by Catalyst. If the user is added by another existing user, the added user's ZAAID will be the same as the ZAAID of the user adding them. The organization of a user cannot be changed later, once it is associated with their account.
  • Catalyst's architecture enables an individual to be a part of multiple Catalyst applications, registered as different user accounts. This means, if a user signs up for more than one Catalyst application, they are assigned a different ZUID for each application. They can also be assigned to different organizations in different Catalyst applications, thereby associating them with a different ZAAID each time. A user account is therefore unique to one particular application alone.

    However, this could also cause inconvenience for the user, as they would have to sign in every time they switch to a different Catalyst application. They would also end up having multiple user accounts of different applications associated with their email address.

    To avoid this problem, you can enable the Zoho or Google sign-in provider option in your applications. This prevents the need for the user to keep track of multiple credentials of different Catalyst applications.
     
  • The Users section in Authentication lists all users, including those who have signed up from inside the application.

Benefits

  • Catalyst Authentication provides an integrated space to manage application users and handle all end user activities.
  • The provision to handle user accounts directly from the Catalyst console, rather than creating additional solutions for it, is highly helpful and time saving.
  • Even if you have included a provision for users to create an account or reset their password from inside your application, you can still perform these activities quickly from the console for your convenience.
  • You can easily manage applications created for internal usage by your organization's members, or that are made accessible by request only using Authentication.
 

Implementation

Add a New User

To add a new user for your application from the Catalyst console:

  1. Navigate to Authentication under Develop.
  2. Click Invite User in the Users section.
  3. Enter the First Name, Last Name, and Email address of the user. Select the Role for the user from the drop-down list in the pop-up window. 
  4. Select the platform of the application that you are inviting the user to access.

    Note: Specifying the platform does not prevent the user from accessing other platforms of the application. However, it defines the primary platform that the user will access from their device and sets default values for opening the application in the appropriate medium.
  5. If you select Web as the platform, a Select Domain option appears in the Redirect URL section. This lists out the domains that you have mapped for your Catalyst application and the default Web App URL provided by Catalyst. If you have not mapped a domain for your application, the default Web App URL alone is available.
    Note: If you are inviting the user from the Production environment of your project, the production URL will be available in the drop-down list as the default Web App URL. If you are inviting them from the Development environment, the default development URL will be available instead. Refer to the Environments help page for more information.
    Select a domain from the drop-down list.

    If you select Android or iOS as the platforms, you can just type in the redirect URL.
  6. You can use the default homepage that you have specified in your web app's client-package.json file as the redirect URL by checking the Use Default Redirect URL checkbox. To use a different redirect URL, type the URL in text box.
    Note: If you don't enter any redirect URL for the Web or a mobile application platform and if you leave the Use Default Redirect URL box unchecked as well, the user will not be redirected anywhere after their sign-up or password reset.
  7. Click Create.

The user will now be listed in the Users section along with their details. You can search for a particular user by their email address using the search bar.

When a new user is invited, Catalyst will send an automated email to their email address, in the email verification template, with a URL to set up their password.  

When the user clicks on the link, they are redirected to Catalyst's default sign-up form, where they can set up a password to access the application.

Once the user clicks Update, they are redirected to the redirect URL that you specified while inviting the user. If the user was invited through other mediums, they will be redirected to the default redirect URL of your application automatically.

 

Enable or Disable a User

You can enable or disable a user of your application as you need. When a user is disabled for an application, they will no longer be able to login to the application until you enable them again.

To enable or disable a user, click the toggle switch in the Status column for the user.


 

Reset a User's password

You can reset a user's password by easily sending them a password reset email from the Catalyst console. The email will contain a password reset link, which the user can click to create a new password for the application. 

To reset the password of a user of your application:

Note: The password will be reset for all platforms, irrespective of the platform you choose. Specifying the platform sets default values for opening the application in the appropriate medium.
  1. Click Reset Password for the user in the Users section of Authentication.
  2. Select the platform of the application for which the password is to be reset in the pop-up window.
  3. If you select Web as the platform, a Select Domain option appears, similar to the Create User pop-up window. Refer to Add a New User section for details. 

    Select a domain from the drop-down list.
  4. To use the default redirect URL, check the Use Default Redirect URL checkbox. To use a different redirect URL, type the URL in the text box.
    Note: The Select Domain option only applies to Web apps. If you select Android or iOS as the platforms, you can just enter the redirect URL.
  5. Click Create.

This will automatically send a password reset email to the user's email address for the application platform that you have chosen.

When the user clicks on the link, they will be redirected to a page where they can create a new password for their account.

When the user clicks Reset Password, their password will be reset and they will redirected to the redirect URL that you specified.

You can customize the template of this password reset email, as mentioned in Key Concepts. Refer to the Email Templates page for details.

Note: The Reset Password link in the Users section is a shortcut for sending the password reset email to the user from the console. You can also send a password reset email using Java, Node.js, Web SDKs or the API.
 

Modify a User's Details

You can modify and update a user's name or the role that they were assigned to. However, you will not be able to change a user's registered email address.

To modify user information in your application:

  1. Click the ellipsis icon for the user whose information you wish to modify and click Edit in the Users section of Authentication.
  2. Make the necessary changes in the pop-up window and click Update.
 

Delete a User

You can permanently delete a user from logging in to your application. The user will need to re-register in your application if they want to use it again.

To delete a user account from your application:

  1. Click the ellipsis icon for the user you wish to delete in the Users section of Authentication, and click Delete.
  2. Click Delete.
  3. Click Yes, Proceed in the confirmation window.

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocatalyst.com