Configuring LDAP

Detailed instructions for configuring Lightweight Directory Access Protocol (LDAP).

By default, the dynamic domain manager, the Dynamic Workload Console, and the master domain manager are configured to use a local file-based user repository. For more information about supported authentication mechanisms, see Available configurations.

You can implement a basic user registry or an LDAP-based user repository by configuring the sample authentication templates provided in XML format. The following are the supported authentication methods and the corresponding sample template that can be configured to replace the configuration file currently in use:

File-based: auth_basicRegistry_config.xml
IBM® Directory Server: auth_IDS_config.xml
OpenLDAP: auth_OpenLDAP_config.xml
Windows Server Active Directory: auth_AD_config.xml

You can further customize the templates by adding additional elements to the XML files. For a full list of the elements that you can configure to complement or modify the configuration, see the related WebSphere Application Server Liberty Base documentation, for example LDAP User Registry (ldapRegistry).

To configure an LDAP user registry, see Configuring an LDAP user registry.

To configure a basic user registry, see Configuring a basic user registry.

Configuring an LDAP user registry

To configure a common LDAP for both the IBM® Workload Scheduler and the Dynamic Workload Console, complete the following steps:

Assign a role to your LDAP group.
1. Log in to the Dynamic Workload Console as administrator and access the Manage Roles page.
2. Add a new Entity of type Group to the role you want to assign to your LDAP group and click Save.
Update the authentication configuration template file with the details about your LDAP server.
1. Copy the template file to a working directory. The templates are located in the following path:
  Dynamic Workload Console
  
  DWC_DATA_dir/usr/servers/dwcServer/configDropins/templates/authentication
  
  master domain manager
  
  TWA_DATA_DIR/usr/servers/engineServer/configDropins/templates/authentication
  Dynamic Workload Console
  
  DWC_home\usr\servers\dwcServer\configDropins\templates\authentication
  
  master domain manager
  
  TWA_home\usr\servers\engineServer\configDropins\templates\authentication
2. Edit the template file in the working directory with the desired configuration.
3. Optionally, create a backup copy of the configuration file in a different directory, if the file is already present. To avoid conflicts, ensure the backup copy is in a directory different from the following directories: configDropins/templates and configDropins/overrides.
4. Copy the updated template file to the overrides directory.
5. The overrides directory is located in the following path:
  Dynamic Workload Console
  
  DWC_DATA_dir/usr/servers/dwcServer/configDropins/overrides
  
  master domain manager
  
  TWA_DATA_DIR/usr/servers/engineServer/configDropins/overrides
  Dynamic Workload Console
  
  DWC_home\usr\servers\dwcServer\configDropins\overrides
  
  master domain manager
  
  TWA_home\usr\servers\engineServer\configDropins\overrides
6. Stop and restart WebSphere Application Server Liberty Base using the stopappserver and startappserver commands located in TWA_home/appservertools.
For more information about configuring an LDAP registry, see the WebSphere Application Server Liberty Base documentation, for example: Configuring LDAP user registries in Liberty and Federation of user registries.

Configuring a basic user registry

You can use a basic user registry by defining the users and groups information for authentication on WebSphere Application Server Liberty Base.

To configure basic user registry, complete the following steps:

Copy the auth_basicRegistry_config.xml template from the templates folder to a working folder.
Edit the template file in the working folder with the desired configuration by adding users and groups as necessary.
To add a user, add an entry similar to the following in the basicRegistry section:
```
<user name="nonadminuser" password="{xor}Ozo5PiozKw=="/> 
```
To add a group, add an entry similar to the following in the basicRegistry section:
```
<group name="TWSUsers">
        <member name="nonadminuser"/>
        </group> 
```
Store the password in xor format using the WebSphere Application Server Liberty Base securityUtility command, as described in securityUtility command.

This utility requires the JAVA_HOME environment variable to be set. If you do not have Java installed, you can optionally use the Java version provided with the product and available in:

IBM Workload Scheduler

<INST_DIR>/TWS/JavaExt/jre/jre

Dynamic Workload Console

<DWC_INST_DIR>/java/jre/bin
Create a backup copy of the configuration file in the overrides folder, if already present.
Copy the updated template file to the overrides folder. Maintaining the original folder structure is not required.