Set Up d.velop Client (Cloud variant of d.velop)

The goal of these instructions is to enable amber to access the D.velop environment. For that amber needs a d.velop account and an API key. Furthermore, amberSearch needs a connection to d.velop via an OpenID protocol to enable the Single Sign On. In the following, the necessary steps are visually described.

Step 1. Create a new d.velop account for amber

1.1 Go to the Configuration (Konfiguration), then Administration (Verwaltung) and then Users and groups (Benutzer und Gruppen)

1.2 Create a new user

1.3 Grant read permissions to all (relevant) files

1.4 Grand admin permissions to the created user (this is necessary to retrieve the necessary information from the Dvelop API to index the data)

Step 2. Create an API Key

2.1 Go to Configuration (Konfiguration), then go to Infrastructure and security (Infrastruktur und Sicherheit) and then Login options (Anmeldeoptionen)

2.2 Click on the fingerprint Icon as shown in the screenshot below

2.3 Create a new API key

2.4 Select the amber user account

2.5 Go back to the previous page and select the newly created API key

2.6 Copy the API key

2.7 Provide the copied value to the amber Team.

Step 3. Create an OpenID connection

3.1 Go to Configuration (Konfiguration), then Infrastructure and security (Infrastruktur und Sicherheit) and then Setting OpenID-provider (Einstellung des OpenID-Providers)

3.2 Click on the + button to create a new connection

3.3 Configure the OpenID connection. The name should be amber, Redirect-URL (Weiterleitungs-URL) will be provided to you by the amber Team. Then save.

3.4 A dialog window will pop up. Copy the Client-ID and Client Secret (Clientschlüssel) and provide them to the amber team.

3.5 At the overview page of the available OpenID connections copy the endpoint URLs and provide them to the amber team

Final checklist

- Add the amber account to d.velop

- Provide the credentials of the amber account to the amber Team

- Provide the API key to the amber Team

- Provide the Client-ID and Client secret to the amber Team

- Provide the OpenID endpoints URLs to the amber Team

If you need assistance please reach out to us via IT@amber.de