There are a few parameters that need to be defined in the i2b2 Admin if you want to use Active Directory services as your i2b2 authentication method. i2b2 supports NTLMv1, NTLMv2 authentication protocols, and OKTA authentication.
The required parameters are listed in the following tables depending on the type of protocol used.
NTLMv1 authentication:
Parameter Name | Values | Required |
|---|---|---|
authentication_method | NTLM | Yes |
domain | Example: i2b2.org | Yes |
domain_controller | Example: pdc.i2b2.org | Yes |
NTLMv2 authentication:
Parameter Name | Values | Required |
|---|---|---|
authentication_method | NTLM2 | Yes |
domain | Example: i2b2.org | Yes |
domain_controller | Example: pdc.i2b2.org | Yes |
OKTA authentication:
Parameter Name | Values | Required |
|---|---|---|
authentication_method | OKTA | Yes |
domain | Example: i2b2.org | Yes |
domain_controller | Example: pdc.i2b2.org | Yes |
In the i2b2 there are different types of parameters that can be defined.
Individual users log in using Active Directory services
- In this scenario, not all users are affected.
- Only those users who have the parameters defined with being required to use their domain (network) id and password to log into i2b2 Web Client, Workbench, and Admin (if they have access).
- Users who do not have the parameters defined will log in using the standard i2b2 authentication method.
- Type of Parameter: User parameter
- The parameters are defined on the user level.
- User parameters only affect the user in which they are entered on.
Note
For those who are not familiar with the i2b2 Admin, here is a quick note on how to navigate around the pages.
For the most part, the i2b2 Admin is comprised of two panels.
The panel on the left is the Navigation panel and contains a number of items that are displayed in a hierarchical tree. These items are grouped together based on their function. (Manage Hive, Manage Cells, Manage Projects, Manage Users)
The information that displays in the panel on the right is driven by whatever item is selected in the Navigation panel. If you click on Manage Users the Manage Users page will display on the right. If you click on a user name in the Navigation panel the Edit User page will display.
Steps to Setup Active Directory Parameters
Assumption: The following steps assume you are already logged into the i2b2 Administration Module. If you do not know how to login please see the chapter titled i2b2 Administration Module Install.
Warning
The below steps are written for adding a user parameter. If you wish to add a hive parameter you can interchange the first three steps with the following two steps:
At this point the steps for adding a parameter are the same so can continue entering your parameters by jumping to the 4th step.
Parameter Value:
NTLM ( for using NTLMv1 protocol)
NTLM2 ( for using NTLMv2 protocol)
OKTA (for using OKTA authentication)
Note
The Navigation panel will not automatically refresh to display the new parameter. If you wish to update the list in the Navigation panel you can click on Params and it will refresh the hierarchical tree.
