# IGA

Identity Governance Administration

# Connect Soffid syncserver to your on-premise network

## Description

In order to manage your information system, a component named Sync Server must be installed along with Soffid Console. You must choose one platform as your Sync Server Soffid host and follow the instructions.

Once you have run the corresponding scripts, Soffid will detect the new Sync server. You could check the new Sync server on the **[Synchronization servers page](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/synchronization-servers "Synchronization servers").**

## Step-by-step

### 1. Platform

First, you must select the platform.

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-10/scaled-1680-/4nTavnggGkWhk0rt-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-10/4nTavnggGkWhk0rt-image.png)

<p class="callout warning">Please note that some values are generated based on the following parameters; please check them if you encounter any issues.</p>

<p class="callout info">The **hostname:port** used in the following commands is generated to these rules: it uses the **soffid.externalURL** parameter, if this does not exit, it uses the **AutoSSOURL** parameter, if this does not exit, Soffid tries to **generate** the hostname:name.</p>

#### 1.1 Debian, Ubuntu, or any other Debian derivatives

Follow the instructions.

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-10/scaled-1680-/zxB8qOhspkXq0bYP-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-10/zxB8qOhspkXq0bYP-image.png)

#### 1.2 Redhat, Centos, or Suse

Follow the instructions.

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-10/scaled-1680-/1ERIAOGUXsPgOSTS-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-10/1ERIAOGUXsPgOSTS-image.png)

#### 1.3 Windows

Follow the instructions.

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-10/scaled-1680-/3su78qKfuWwK17Jh-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-10/3su78qKfuWwK17Jh-image.png)

#### 1.4 Docker

Follow the instructions.

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-10/scaled-1680-/4KwCXXA2Jj4lemP8-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-10/4KwCXXA2Jj4lemP8-image.png)

<p class="callout info">To upgrade the syncserver proxy version, follow the instructions at the following link: [Upgrade syncserver proxy](https://bookstack.soffid.com/books/installation/page/upgrade-syncserver-proxy "Upgrade syncserver proxy")</p>

#### 1.4.2 Docker compose

We can also use the Docker URL in a docker compose file.

This is the template to use in your docker-compose.yaml file.

<p class="callout warning">Replace the **VERSION** and **DOCKER-URL-COPIED-FROM-WIZARD** parameters with their values.</p>

```
services:

  syncserver-proxy:
    image: soffid/iam-sync:VERSION
    hostname: syncserver-proxy
    environment:
      SOFFID_CONFIG: 'DOCKER-URL-COPIED-FROM-WIZARD'
    networks:
      - network
    volumes:
      - syncserver-proxy-conf:/opt/soffid/iam-sync/conf

networks:

  network:
    name: network
    driver: bridge

volumes:

  syncserver-proxy-conf:
    name: syncserver-proxy-conf
```

<p class="callout info">To update the proxy version on the synchronisation server, simply update the syncserver version and redeploy the container.</p>

<p class="callout info">Here is some further information on [Docker Compose commands](https://bookstack.soffid.com/books/utilities/page/docker-compose-commands "Docker compose commands").</p>

### 2. Confirmation

Finally, Soffid will detect that the Sync Server has been successfully installed and you can click the Finish button.

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-10/scaled-1680-/EIOKue074mKUKyjg-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-10/EIOKue074mKUKyjg-image.png)

<p class="callout success">You could check the new Sync server on the [Synchronization servers](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/synchronization-servers "Synchronization servers") page and in the [Sync server monitoring](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/sync-server-monitoring "Sync server monitoring") page.</p>

# Create identities (manually, CSV file or authoritative source)

## Description

You need to register the identities to manage and protect them. This wizard allows you to choose the easiest way to do it.

## Step-by-step

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">1. </span>First, you must select one option to register the identities. Soffid allows you three options.

[![image-1677151715487.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1677151715487.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1677151715487.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2. </span>You must follow the steps, depending on the selected option:

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.1. </span>**Load from a CSV file**: this option allows you to load identities from a CSV file.

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.1.1. </span>First of all, you need to pick up the CSV file.

[![image-1677151980079.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1677151980079.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1677151980079.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.1.2. </span>Second, Soffid will display the file data to check contents

[![image-1677152756166.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1677152756166.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1677152756166.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.1.3. </span>Then you must select the proper mapping for each CSV file column. And finally, click the Import Button and Soffid will add the identities to the platform.

[![image-1677152797214.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1677152797214.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1677152797214.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.1.4. </span>Soffid will display the result of the process.

[![image-1677152920695.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1677152920695.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1677152920695.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.2. </span>**Configure an authoritative data source to always have up-to-date information**: this option allows you to configure an Active Directory agent, or a Relational database agent to load the identities.

Once the process will finish, you could check the new agent on the agent's page `Main Menu > Administration > Configuration > Integration engine > Agents`

<p class="callout info">For more information about the agents, you can visit [the Agents page](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/agents).</p>

[![image-1677152049535.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1677152049535.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1677152049535.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.2.1. </span>Active Directory

- To configure the AD connection you must fill in the required fields and click the Next button.
- Then Soffid will run the Authoritative load and the Reconcile process
- Finally, you could check the result on the [Scheduled tasks ](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/scheduled-tasks)page.

[![image-1685436631243.png](https://bookstack.soffid.com/uploads/images/gallery/2023-05/scaled-1680-/image-1685436631243.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-05/image-1685436631243.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.2.2. </span>Relational database (SQL)

[![image-1685436774882.png](https://bookstack.soffid.com/uploads/images/gallery/2023-05/scaled-1680-/image-1685436774882.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-05/image-1685436774882.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2.3. </span>**Register them manually**: this option browses to the **[User page](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/users)** to register the identities manually

[![image-1677153597024.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1677153597024.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1677153597024.png)

# Add applications

## Description

The wizard allows you to add Applications or **[Information Systems](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/information-systems)** to Soffid as well. The wizard allows you to choose from an application list. Once you choose one of them, you must fill in the required fields to connect to this application. Then the Reconcile process will be launched.

## Step-by-step

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">1. </span>First, you need to select the proper application to add. Soffid provides you a huge application list to configure.

[![image-1677497120165.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1677497120165.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1677497120165.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">2. </span>Once you select the application, you must configure the connection parameters.

[![image-1685437011704.png](https://bookstack.soffid.com/uploads/images/gallery/2023-05/scaled-1680-/image-1685437011704.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-05/image-1685437011704.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">3. </span>Then, Soffid allows you to choose the strategy to load accounts.

[![image-1685437664369.png](https://bookstack.soffid.com/uploads/images/gallery/2023-05/scaled-1680-/image-1685437664369.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-05/image-1685437664369.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">4. </span>Then Soffid will run the reconcile process

[![image-1678090555705.png](https://bookstack.soffid.com/uploads/images/gallery/2023-03/scaled-1680-/image-1678090555705.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-03/image-1678090555705.png)

<span style="color: #a6d100; font-weight: bold; font-size: 18px;">5. </span>Finally, the process ends.

[![image-1685437831278.png](https://bookstack.soffid.com/uploads/images/gallery/2023-05/scaled-1680-/image-1685437831278.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-05/image-1685437831278.png)

# Design user life cycle workflows

## Description

When you select the option "Design user life cycle workflows", Soffid will browse to the BPM Editor page, where you could define new workflows or import existing workflows from a file.

<p class="callout info">For more information, you can visit [the BPM Editor book](https://bookstack.soffid.com/books/bpm-editor).</p>

## Screen overview

[![image-1676907389549.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1676907389549.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1676907389549.png)