GLPI
Configure the GLPI API connector to retrieve information via the GLPI API
This document describes the procedure for configuring the GLPI API connector to retrieve information via the GLPI API.
Objective
The purpose of this connector is to provide a method for configuring the GLPI API to retrieve necessary information using User Token and App-Token authentication.
Prerequisites
- Administrator access to GLPI
- GLPI REST API enabled
Procedure
Enable API
- Access API configuration:
- Navigate to Setup > General > API.
- Enable the required options:
- Enable "External token" to allow external token authentication.
- Enable "Credentials" to allow username/password authentication.
- Click Save.
Create API Client
- Access API Client Configuration:
- Navigate to Setup > General > API.
- Add an API client:
- Click Add API Client.
- Configure the API client:
- Give the client a name (e.g., "OverView Integration").
- Set "Active" to "YES".
- Configure IP restrictions (optional).
- Click Add.
- Retrieve the App-Token:
- The App-Token will be displayed after creation.
- Copy and store the App-Token securely (save it immediately).
Get User-Token
- Generate User API Token:
- Log in to GLPI as the user who will authenticate API requests.
- Click on your User Profile (top-right).
- Navigate to Remote access keys section.
- Click Regenerate to generate a new API token.
- Copy and store the User-Token securely.
Required Permissions
In GLPI, go to Administration > Profiles, then select the profile assigned to the API user. The profile must have Read access on the following rights:
- Administration > Agent (Inventory section): to collect agent data
- Setup > Components: to collect processor data
- Administration > Users: to collect user and email data
- Assets > Computers: to collect devices and their antivirus
- Assets > Monitors: to collect monitors
- Assets > Phones: to collect phones
- Assets > Printers: to collect printers
- Assets > Network devices: to collect network equipment, and the network ports of every asset
- Assets > Software: to collect software installed on a device
- Assets > Consumables: to collect consumables, only when the Include Consumables parameter is enabled
- Management > Domains: to filter assets by domain, only when the Domains to import parameter is set
The profile must also be assigned to the API user on the root entity with the Recursive option enabled (Administration > Users > the API user > Authorizations). Without it, assets and users belonging to other entities are rejected and are missing from the import, even when the rights above are granted.
Information to provide in OverView
| Field | Description |
|---|---|
| User Token | Retrieved from the user's Remote access keys section |
| App Token | Retrieved from Setup > General > API (client configuration) |
| API URL | The URL you use to open GLPI in a browser, without a trailing slash — https://glpi.example.com if GLPI is served at the root of the domain, https://example.com/glpi if it is served from a subdirectory. The connector appends /apirest.php/ itself, so do not add it. |
Parameters
These parameters are optional. Leave them at their default value unless you have a specific reason to change them.
| Parameter | Description | Default |
|---|---|---|
| Exclude Asset Types | Asset types to exclude from import. Any of: Computer, Phone, Printer, Monitor, Network Equipment | — |
| Include Consumables | Import GLPI consumables: one asset per consumable unit, with its status (New or Used) and the user it was given to. Requires the Assets > Consumables right | Disabled |
| Domains to import | Only assets linked to one of these GLPI domains (Domains tab of an asset) are imported, case-insensitively. Assets without any domain are not imported: in GLPI these are usually monitors, printers, network equipment, consumables and devices never inventoried by an agent. The import fails if none of the domains exists in GLPI. Requires the Management > Domains right | — |
Alternative: file import through DropPoint
The API access described above is the recommended method for this connector. Where it is not available (a segregated network, a version or licence without API, an export you already produce), OverView accepts file exports, to be uploaded to the bucket dedicated to GLPI.
Bucket : s3://glpi/
Example : s3://glpi/export.csv
The procedure is described in the OverView DropPoint guide: generating credentials, configuring the client, then sending files from the OverView web interface, the AWS CLI or an SDK. Its examples come pre-filled with this bucket when you follow this link.
Official Documentation
For more information, see the GLPI API Documentation