Skip to content

GLPI 11 and 12 only

The OAuth2 high-level API (/api.php) was introduced in GLPI 11. If you are running GLPI 10.x, use GlpiAPI or AsyncGlpiAPI instead.

GLPI 11.0.6+ recommended

DELETE and Timeline sub-item endpoints (Followup, Task, Solution) return ERROR_RIGHT_MISSING in GLPI 11.0.5 regardless of profile permissions. This bug was fixed in GLPI 11.0.6. Upgrade before using these operations via the HL API.

OAuth2 (High-level API)

GLPI 11 introduced a modern REST API at /api.php that uses OAuth2 for authentication (HL API 2.x). GLPI 12 adds HL API 3.0 and keeps 2.3. Use GlpiOAuthClient or AsyncGlpiOAuthClient for this.


Setup in GLPI

  1. Go to Setup → OAuth clients → Add
  2. Set a name, note the Client ID and Client Secret
  3. Set Grants: Password (required for API access)
  4. Set Scopes: api
  5. Save

client_credentials grant

The client_credentials grant is not supported for the api scope in GLPI 11 and 12. It only works for the inventory scope. Always use the password grant for ticket/asset API access.


Pass username and password in the constructor — they are used automatically on authenticate() and on any token refresh:

from glpi_utils.oauth import GlpiOAuthClient

with GlpiOAuthClient(
    url="https://glpi.example.com",
    client_id="my-app",
    client_secret="my-secret",
    username="glpi",
    password="glpi",
) as api:
    api.authenticate()
    tickets = api.ticket.get_all_pages()
    print(f"{len(tickets)} tickets")

Async

import asyncio
from glpi_utils.oauth import AsyncGlpiOAuthClient

async def main():
    async with AsyncGlpiOAuthClient(
        url="https://glpi.example.com",
        client_id="my-app",
        client_secret="my-secret",
        username="glpi",
        password="glpi",
    ) as api:
        await api.authenticate()

        tickets = await api.ticket.get_all_pages()

        async for page in api.ticket.iter_pages(page_size=100):
            for ticket in page:
                print(ticket["name"])

asyncio.run(main())

Automatic token refresh

Bearer tokens expire (default 1 hour in GLPI). The clients re-authenticate transparently when the token is about to expire — no manual handling needed:

with GlpiOAuthClient(
    url="...", client_id="x", client_secret="y",
    username="glpi", password="glpi",
) as api:
    api.authenticate()
    # Script runs for several hours — token renewal is automatic.
    for page in api.ticket.iter_pages():
        process(page)

Environment variables

export GLPI_URL=https://glpi.example.com
export GLPI_OAUTH_CLIENT_ID=my-app
export GLPI_OAUTH_CLIENT_SECRET=my-secret
export GLPI_OAUTH_USERNAME=glpi
export GLPI_OAUTH_PASSWORD=glpi
api = GlpiOAuthClient()   # reads all from env
api.authenticate()

Full CRUD support

GlpiOAuthClient exposes the same interface as GlpiAPI. Internally, itemtypes are mapped to their namespaced HL API paths automatically (Ticket → Assistance/Ticket, Computer → Assets/Computer, etc.):

# Read
ticket = api.ticket.get(1)
all    = api.ticket.get_all_pages()

# Create / Update / Delete
new = api.ticket.create({
    "name": "Test", "content": "...",
    "type": 1, "status": 1, "urgency": 3, "impact": 3, "priority": 3,
})
api.ticket.update({"id": new["id"], "status": 2})
api.ticket.delete({"id": new["id"]})

# Timeline sub-items (Followup, Task, Solution, Validation)
api.ticket.add_sub_item(new["id"], "ITILFollowup", {
    "content": "Work in progress.", "is_private": 0,
})
followups = api.ticket.get_sub_items(new["id"], "ITILFollowup")

# Non-standard itemtypes — pass full path
api.item("Assets/Socket").get_all()

API versions (GLPI 12)

Without api_version, requests go to /api.php/... and the server picks its newest HL API: 2.3 on GLPI 11, 3.0 on GLPI 12. Pin the version so a GLPI upgrade does not change the response schemas:

api = GlpiOAuthClient(url="https://glpi.example.com", client_id="my-app",
                      client_secret="my-secret", username="glpi", password="glpi",
                      api_version="2.3")      # or GLPI_API_VERSION=2.3
api.authenticate()
api.get_version()        # GLPIVersion('12.0.0')
api.get_api_versions()   # versions the server offers
GLPI Versions offered Unversioned requests get
11.0.x 2.0, 2.1, 2.2, 2.3 2.3
12.0.x 2.3, 3.0 3.0

api_version accepts "2", "2.3", "3", "3.0" or "v3.0". A major-only value lets the server choose the newest minor of that major. The token endpoint (/api.php/token) is never versioned.

Changes in HL API 3.0 (GLPI 12), from the 12.0.0 OpenAPI documents:

Area 2.3 3.0
KB categories Knowledgebase/Category, schema KBCategory removed; articles have parents
KBArticle categories parents, is_favorite
ITILCategory knowbase_category knowbase_article
Software licenses Assets/SoftwareLicense (deprecated) removed; use Management/License
Team members TeamMember UserTeamMember, GroupTeamMember, SupplierTeamMember
OLA - group added
Login sessions - Security/LoginSession/{My,All,{users_id}}, DELETE .../{login_session_uid}
Custom assets state status

The HL API paginates with start and limit (default limit 100) and ignores the legacy range parameter. get_all_pages() and iter_pages() send start/limit, and get_all(range="0-49") is translated to start=0&limit=50.

search() takes an RSQL filter:

api.search("Ticket", filter="name=like=*srv*;status.id==1", limit=20, sort="date_mod:desc")

Operators: ==, !=, =lt=, =le=, =gt=, =ge=, =in=(a,b), =out=, =like=, =ilike=, =isnull=, =notnull=, and on GLPI 12 =istruthy= / =isnottruthy=. ; is AND, , is OR.


HL API route map

The High-Level API groups resources into namespaces. The library maps the standard itemtype names automatically:

Alias / Itemtype HL API path
ticket Assistance/Ticket
problem Assistance/Problem
change Assistance/Change
computer Assets/Computer
monitor Assets/Monitor
printer Assets/Printer
networkequipment Assets/NetworkEquipment
software Assets/Software
user Administration/User
group Administration/Group
entity Administration/Entity
contract Management/Contract
supplier Management/Supplier
document Management/Document
category Dropdowns/ITILCategory
knowledgebase Knowledgebase/Article
SoftwareLicense Management/License
ITILFollowup Timeline/Followup (sub-item only)
TicketTask Timeline/Task (sub-item only)
ITILSolution Timeline/Solution (sub-item only)
TicketValidation Timeline/Validation (sub-item only)
Document Timeline/Document as a sub-item, Management/Document otherwise

For unmapped itemtypes (plugins, custom assets), pass the full path directly: api.item("Assets/Custom/MyType").