Users | QuickBlox

📘
All your users are confined to a QuickBlox application. Thus, there is no conflict when the same user is created by another QuickBlox application.
All users in your QuickBlox application can communicate across multiple platforms. In other words, your iOS, Android, or web users can communicate with each other.

Visit our Key Concepts page to get an overall understanding of the most important QuickBlox concepts.

View list of users

To list users, follow the steps below:

Navigate to the Dashboard => YOUR_APP => Users page. Here you will see a list of all existing application users.
Enter a user ID into the search to list a specific user.

Create user

There are two ways you can create users for your QuickBlox application:

Create users using Server API.
Create users in the QuickBlox Dashboard.

To create an application user via the Dashboard, follow the steps below:

Navigate to Dashboard => YOUR_APP => Add new user in the QuickBlox Dashboard.
Fill in the Add user profile info. Enter the email/login, password, and confirm the password for the new user account. These parameters are required for creating a user.
Click the Add user button. Similarly, you can create more users in the Dashboard.

📘
You can create a read-only admin user. The read-only admin user is a user with an administrator role who has view access to most data in the Dashboard. They are unable to edit data. To grant a read-only access to a user, follow the steps below:

Navigate to the Dashboard => YOUR_APP => Users in the QuickBlox Dashboard.

Find a user you want to grant a read-only access to.

Check the Is admin (read only).

Click the Save and close button.

Update user

To update a user, follow the steps below:

Navigate to the Dashboard => YOUR_APP => Users page. Here you will see a list of all existing application users.
Choose the ID of the user you want to update and click on it.
Edit the profile of the user.
Click the Save and close button to save changes.

📘
Confirmed addresses cannot be updated right away. As soon as the email is confirmed, it is updated. See this section to learn more about email confirmation.

Delete user

To delete a user, follow the steps below:

Navigate to the Dashboard => YOUR_APP => Users page. Here you will see a list of all existing application users.
Check the user you need to delete.
Click the Remove selected.

📘
When the account owner deletes a user, all data associated with the user are deleted from the system. Thus:

All files associated with the user are deleted.

All custom objects associated with the user are deleted.

All dialogs where the user is a dialog owner are deleted.

If a user is a dialog occupant and not a dialog owner, their ID is deleted from the occupants IDs list of all group dialogs they participate in. However, a user isn't removed from occupants IDs list of private dialogs.

Configure email notifications

You can set templates of email notifications that will be sent to your users. You can use the user-specific tags described below:

User:

#{user.full_name}
#{user.email}
#{user.login}
#{user.phone}
#{user.website}
#{user.created_at}
#{user.updated_at}
#{user.last_request_at}
#{user.external_user_id}
#{user.facebook_id}
#{user.twitter_id}
#{user.blob_id}
#{user.get_reset_password_token}
#{user.get_confirmation_token}
#{user.show_name}

App:

#{app.title}
#{app.url}
#{app.description}

🚧
Make sure to enable the email confirmation. This functionality allows application users to confirm their emails. If a user doesn't confirm the email, the emails won't be sent to this user.

📘
HTML <title> tag would be present in email subject.
If you want to use your custom template, be aware that many mail servers disallow most of standard HTML tags.

Greetings template

You can set a 'Greetings' template of email notifications that will be sent to your app users when they sign up. To set the 'Greetings' email, follow the steps below:

Enable the email confirmation functionality. See this section for more details.
Navigate to the Dashboard => YOUR_APP => Users => Email Notifications page.
Check the Enable 'Greetings' email template.
Choose the Greetings email from the dropdown.
Create an email template using the supported tags listed above.
Click the Save changes button. You can also click the Save and preview or Save and send test email option to preview or test the email template.

📘
Note that many mail servers block some standard HTML tags.

🚧
If the Enable 'Greetings' email is not checked, the users won't receive any emails.

Reset password template

You can set the 'Reset password' template of email notifications that will be sent to your app users who want to reset their passwords. To set the 'Reset password' template, follow the steps below:

Enable the email confirmation functionality. See this section for more details.
Navigate to Dashboard => YOUR_APP => Users => Email Notifications page.
Check the Enable custom 'Reset password' email template.
Choose the Password reset email from the dropdown.
Create an email template using the supported tags listed above. Add the #{user.get_reset_password_token} to reset password link to the template. For example, https://api.quickblox.com/password_reset?token=#{user.get_reset_password_token}. Thus, when the user clicks on the emailed link, the token is going to be sent back to the application as part of the URL.
Click the Save changes button. You can also click the Save and preview or Save and send test email option to preview or test the email template.

🚧
If the Enable custom 'Reset password' email is not checked, the users will receive a default QuickBlox email.

📘
You can also use your own server/page to perform the password reset operation. In this case, your web page should perform a request to QuickBlox server to save new password:
PUT https://api.quickblox.com/update_password.json.
Pass the following parameters within the request body:

user[reset_password_token]

user[password]

user[password_confirmation]

Email confirmation template

You can set the 'Email confirmation' template of email notifications that will be sent to users when they sign up. To set the 'Email confirmation' template, follow the steps below:

Enable the email confirmation functionality. See this section for more details.
Navigate to the Dashboard => YOUR_APP => Users => Email Notifications page.
Check the Enable custom 'Email confirmation' email template.
Choose the Confirmation email from the dropdown.
Create an email template using the supported tags listed above. Add the #{user.get_confirmation_token} to the email confirmation link in the template. For example, https://api.quickblox.com/confirm_email?token=#{user.get_confirmation_token}. Thus, when the user clicks on the emailed link, the token is going to be sent back to the application as part of the URL.
Click the Save changes button. You can also click the Save and preview or Save and send test email option to preview or test the email template.

🚧
If the Enable custom 'Email confirmation' email is not checked, the users will receive a default QuickBlox email.

Configure user settings

You can set the following settings for your users:

Data privacy and safety

There is a way to restrict access to your users' data. Just navigate to the Dashboard => YOUR_APP => Users => Settings => Privacy and safety section. The section includes two checkboxes that are enabled by default:

Allow to retrieve a list of users via API
Allow to retrieve other users' info via API

🚧
If you uncheck the Allow to retrieve other users' info via API, you won’t be able to access chat functionality.

Email confirmation

The functionality enables application users to confirm their emails. Make sure to enable the email confirmation. To enable the email confirmation, proceed as follows:

Go to the Dashboard => YOUR_APP => Users => Settings => User registration confirmation and check the box.
Click the Save button.

🚧
If a user doesn't confirm the email, the emails won't be sent to this user. As a result, password reset functionality won't work.

New contact joined from address book notifications

There is a way to get a push notification when some contact from your address book has been registered in the app. You can enable this feature at QuickBlox Dashboard as follows:

Follow the Dashboard => YOUR_APP => Users => Settings direction
Enable push notifications for new contacts.
Click the Save button.