Using the User Management Connector

The User Management Connector enables the management of users and their roles directly from Miracle Studio, and eliminates the need for an enterprise authentication and identity provider such as Active Directory. This was a requirement put forward by multiple clients who wanted to roll out Miracle Apps faster, without having to integrate them with their enterprise identity provider.

Enabling the User Management Connector

The User Management Connector has to be enabled and configured before it can be used in an application instance in Miracle Studio.

1-UMC

Follow the steps below to enable the User Management Connector:

  1. Click on the UserManagement Connector from the list.
  2. Click on Connections in the left panel of Miracle Studio.
  3. Type a name for the connection in the Connection Name field. 
  4. [Optional Step] Click on Advanced Parameters. You can add custom fields aside from those defined in MiracleTek’s back-end database in Custom Field Definitions. For this step, you will need code written in JSON.
  5. Click on the Test Connection button.

3-UMC

If the test was successful, click Save. If not, re-check the values you entered in the connector’s fields.

Configuring a User Management Connector

After the connector is added, you can configure the connector by clicking Connections in the left menu and clicking Configure button besides the new connection.

4-UMC

Adding Entities to the Connector

Miracle Mobile’s User Management Connector authenticates the login credentials of Miracle Mobile App users, allows registration of new users, and enables password reset.

5-UMC

  1. Click on the Entities tab to view the list of entities used by the connector.
  2. To view the fields in each entity, click on its name under Entities. The fields will be listed in the Fields tab under the Details panel.
  3. Based on the features you wish to include in your mobile application, add the following entities by clicking on the add button.
    1. login –  The entity is used for authenticating the app’s current users.
    2. register – This entity is used to enable new user registration.
    3. forgotPassword – Adding this entity allows app users to retrieve their passwords via email.
    4. changePassword – Including this entity will enable users to change their current passwords.
  4. Click Save Entities.

Defining User Roles

Role-based access control enables Miracle Studio users to carry out a broad range of operations while providing flexibility and breadth of application. You can define user roles through the User Management Connector. 

6-UMC

  1. Click on the User Management tab.
  2. Click on Roles.
  3. Click the Create New Role button.
  4. In Name, enter the role you wish to include.
  5. Click Save.

Adding Users  

You can add Miracle Mobile App users via Miracle Studio. Details of these users will be saved in MiracleTek’s back-end MySQL database hosted on Amazon AWS Cloud in a separate secure VPC.

7-UMC

    1. Click on the User Management tab.
    2. Click on Users.
    3. Click the Create New User button.
    4. Enter values in the following fields:
      • Login ID – Define the ID which mobile app users will use to login.
      • First Name – Type the first name of the mobile app’s user.
      • Middle Name – Type the middle name of the user.
      • Last Name – Enter the last name of the user.
      • Display Name – Type a name that will be visible to the user while interacting with the app.
      • Email – Enter the user’s email address.
      • Password – Enter a password for the user. This can be changed if you add the changePassword entity to the connector (refer to Adding Entities to the Connector section).
      • Assign Roles – Click on the role you wish to assign to the user. This option will only be visible if you have created roles (refer to Defining User Roles).
    5. Click Save.
    6. Click on the Deactivate button associated with a user if you wish to prevent them from logging into the app and accessing its pages and forms.