i2b2 User Registration Guide

A guide on how to do the following:

...

1. add the new user to a project

2. add the project roles to the new user

Enabling or Disabling User Self-Registration

The i2b2 webclient has two ways to self-register, local self-registration and federated self-registration.

Enabling Local User Self-Registration

Modify the file config.php that is located in the directory /var/www/html/webclient/registration/user to enable user self-registration. Set the value of the PHP attribute config_pm_uri to ***'http://127.0.0.1:9090/i2b2/services/PMService/getServices'***.

...

Refresh the webpage and you should see the option to register user (circled in red):

Enabling Federation User Self-Registration

Modify the file i2b2_config_data.json located in the directory /var/www/html/webclient/. Set the value of the attribute showRegistration to true and set the value of the attribute registrationMethod to saml.

...

Refresh the webpage and you should see the option to register user (circled in red):

Disabling User Self-Registration

To disable user self-registration for either local registration or federation registration, set the value of the attribute showRegistration to false in the file file i2b2_config_data.json located in the directory /var/www/html/webclient/.

Self-Registering New User

Local Self-Registering New User

Click on the "Sign Up!" link on the bottom of the i2b2 Login dialog. A "Sign Up" modal will pop up containing a form for self-registering. Fill out the user information on the left of the form. Carefully read the terms-and-conditions, click on the checkbox "I accept the Terms & Conditions", and click on the button "Sign Up" to register on the right side of the form.

...

Once registered, the sign-up modal will disappeared and a confirmation alert will pop up at the main (login) page:

Federation Self-Registering New User

Click on the "Sign Up!" link on the bottom of the i2b2 Login dialog. A "Sign Up" modal will pop up containing a button to redirect you to your Identity Provider (IdP) for logging in:

...

Note that the new user cannot sign in immediately after self-registering. An administrator has to add the new user to a project and add the project roles to the new user. Below is the error shown if the new user attempts to log in immediately after registering:

Adding New User to a Project

In the admin tool, you will see the new self-registered user. Follow the admin tool instructions to add that user to a project.