Credentials for the codebeamer Server

The first step before using LemonTree.Connect codebeamer is to configure a codebeamer server. For this, the codebeamer authentication dialog is used. It is possible to configure multiple server instances with two different authentication methods: username + password and open id connect (OIDC). 

codebeamer Authentication Dialog

There are two possibilities to configure your credentials for a codebeamer Server:

• In the EA main menu, select Specialize > LemonTree.Connect codebeamer > Configure codeBeamer Server Settings.
• Simply start an export or import, if the credentials haven't been configured already, the Authentication dialog will appear.

Configure a codebeamer Server with User / Password Authentication

To configure a codebeamer server with user and password authentication, follow the steps below:

1. Click "New" to create a new server config.

2. Enter the URL.

   Don't forget the URL protocol

   If you enter the URL, make sure to enter the protocol (http://, https://, etc.).

   Open codebeamer URL

   You can directly open the entered codebeamer URL by clicking the globe icon next to the codebeamer URL text box.

3. Enter a user friendly alias for the server config. This alias will be displayed in the left-hand section of the server config dialog.

4. For the authentication method select "Username and Password".

5. Enter your credentials (username and password).

   codeBeamer user with API permission

   Keep in mind, that every user who wants to use LemonTree.Connect must have API permissions. 

6. Hit "Test Connection".

7. If everything was configured accordingly, the codebeamer server version along with a success message should be displayed:
   

8. Hit "Save" to finish the configuration.

The server configuration will be added to the list on the left-hand side. You can create multiple server configurations and switch between them. See Define Multiple Server Configurations for more information.

Configure a codebeamer Server with Open ID Connect (OIDC) Authentication

To configure a codebeamer server with OIDC authentication, follow the steps below:

1. Click "New" to create a new server config.

2. Enter the URL.

   Don't forget the URL protocol

   If you enter the URL, make sure to enter the protocol (http://, https://, etc.).

   Open codebeamer URL

   You can directly open the entered codebeamer URL by clicking the globe icon next to the codebeamer URL text box.

3. Enter a user friendly alias for the server config. This alias will be displayed in the left-hand section of the server config dialog.

4. For the authentication method select "OpenId Connect".
5. Input the URL for the Well-known Configuration.
6. Hit "Get Configuration" to fill out the Token end Auth Endpoint.

7. Enter the Client Id and the Client Secret.

   Client Id auto resolve

   Depending on your OIDC workflow, the client can be possibly determined automatically. If that is the case, simply check the "Client Id auto resolve" checkbox and hit "Get Client Id".

8. Once everything is filled out, you can hit the "Test Authentication" button.

9. You will be redirected to codebeamer to proceed with the OIDC authentication.
10. After logging in, you will be redirected to a success webpage, which you can close.
11. If the authentication was successful, you will see a success message in the server configuration dialog:
    
12. Hit "Save" to finish the configuration.

The server configuration will be added to the list on the left-hand side. You can create multiple server configurations and switch between them. See Define Multiple Server Configurations for more information.

Define Multiple Server Configurations

It is possible to define multiple server configurations. You can add as many server configurations as you wish.

However, only one will be considered as the default configuration, which will be used for all features of LemonTree.Connect (mapping configuration, import, export, etc.)

To see which configuration is currently set as default, there are two ways to do this:

1. In the server configuration dialog:
   1. Open the server configuration dialog with Specialize > LemonTree.Connect codebeamer > Configure codeBeamer Server Settings.
   2. Check the server list on the left-hand side, the default server has an ticked checkbox.
2. In the mapping configuration dialog:
   1. Open the mapping configuration dialog for one package.
   2. The title of the dialog will tell you the codebeamer URL which is currently used.