---
title: Integrate with GLPI
sidebar_label: GLPI
support_level: community
---

## What is GLPI

> GLPI (Gestionnaire Libre de Parc Informatique) is an open-source IT asset management and service desk software. It helps organizations manage hardware, software, tickets, users, and IT services in a centralized environment.
>
> -- https://www.glpi-project.org

## Preparation

The following placeholders are used in this guide:

- `glpi.company` is the FQDN of the GLPI installation.
- `authentik.company` is the FQDN of the authentik installation.

:::info
This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.
:::

## GLPI samlSSO plugin configuration

:::info
By default, GLPI only offers OAuth authentication to subscribers. This guide describes how to integrate authentik with GLPI via SAML using the community plugin named [samlSSO](https://github.com/DonutsNL/samlsso).
:::

### Install the samlSSO plugin

1. Download the latest release from the [samlSSO GitHub project](https://github.com/DonutsNL/samlsso).
2. Unpack the release ZIP file into the `glpi/data/marketplace` directory of your GLPI installation.
3. Log in to GLPI as an administrator and navigate to **Setup** > **Plugins**.
4. Click the Install icon (folder with a `+` symbol) next to the **samlSSO** plugin.
5. In the pop-up window that opens, click **Enable**.

### Add a samlSSO instance

1. Navigate to **Setup** > **samlSSO**.
2. Click the **Add** button and configure the following required settings:
    - On the **General** tab:
        - **Friendly name**: `authentik`
        - **Is active**: toggled on
    - On the **Security** tab:
        - **Strict**: toggled on
        - **JIT user creation**: toggled on

3. Click **Save**.
4. Open the `authentik` samlSSO instance, navigate to the **Service Provider** tab, and take note of the **AcsUrl** and **sloURL**. These values will be required in the next section.

## authentik configuration

To support the integration of GLPI with authentik, you need to create property mappings, and an application/provider pair in authentik.

### Create property mappings in authentik

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to **Customization** > **Property Mappings**, click **Create**, select **SAML Provider Property Mappings**, and click **Next**.
3. Configure the first mapping for the user's _given name_ (first name):
    - **Name**: `givenname`
    - **SAML Attribute Name**: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`
    - **Friendly Name**: Leave blank
    - **Expression**:

    ```python
    return request.user.name.split(" ", 1)[0]
    ```

4. Click **Finish** to save. Then, repeat the process to create a mapping for the user's _surname_:
    - **Name**: `surname`
    - **SAML Attribute Name**: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`
    - **Friendly Name**: Leave blank
    - **Expression**:

    ```python
    return request.user.name.split(" ", 1)[-1]
    ```

5. Click **Finish**.

### Create an application and provider in authentik

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to **Applications** > **Applications** and click **New Application** to open the application wizard.
    - **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. Take note of the **Slug** value as it will be required later.
    - **Choose a Provider type**: select **SAML Provider** as the provider type.
    - **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
        - Set the **ACS URL** to the **AcsURL** value from GLPI.
        - Set the **Service Provider Binding** to `Post`.
        - Set the **SLS URL** to the **sloURL** value from GLPI.
        - Under **Advanced protocol settings**:
            - Select any available **Signing Certificate** and enable **Sign assertions**.
            - Set **NameID Property Mapping** to `authentik default SAML Mapping: Email`.
            - Under **Property mappings**, add the two property mappings that you created in the previous section: `givenname` and `surname`.
    - **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/bindings-overview/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page.

3. Click **Submit** to save the new application and provider.

### Download certificate file

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to **Applications** > **Providers** and click on the name of the provider that you created in the previous section.
3. Under **Related objects** > **Download signing certificate**, click on **Download**. This downloaded file is your certificate file and it will be required in the next section.

## GLPI configuration

1. Log in to GLPI as an administrator and navigate to **Setup** > **samlSSO**.
2. Click on the **authentik** samlSSO instance and configure the following settings:
    - On the **Identity Provider** tab:
        - Set the **Entity ID** to `authentik`
        - Set the **SSO URL** to `https://authentik.company/application/saml/<application_slug>/sso/binding/redirect/`.
        - Set the **SLO URL** to `https://authentik.company/application/saml/<application_slug>/slo/binding/redirect/`.
        - Set **X509 certificate** to the contents of the certificate file that you downloaded from authentik.

3. Click **Save** to apply the changes.

### JIT rules _(optional)_

It's possible to auto-assign profiles and groups when a user is created in GLPI.

1. Log in to GLPI as an administrator, navigate to **Setup** > **samlSSO** > **JIT import rules**, and click **Add**.
2. Provide a **Name**, **Logical operator** type, set **Active** to `Yes`, and then click **Add**.
3. Configure the following settings:
    - On the **Criteria** tab, create a criterion to match users.
    - On the **Actions** tab, create actions to apply to matched users.
        - You may want to add `recursive=yes` as an action, so that matched users have access to all entities.
4. Once finished, return to the **Rule** tab and click **Save**.

## Configuration verification

To confirm that authentik is properly configured with GLPI, log out and click the new authentik login button on the right side. You should be redirected to authentik and once authenticated, you will be signed in to GLPI.

## Resources

- [samlSSO plugin documentation](https://glpi-plugins.readthedocs.io/en/latest/saml/requirements.html)
- [samlSSO plugin wiki](https://github.com/DonutsNL/samlsso/wiki)
