Introduction

General overview

The User Management API (UM API) enables you to read and write user and group data in Kallidus for service-to-service integrations with your HR systems, identity providers, and workforce management tools.

The UM API exposes real-time (live) system-level user and group data across Manage Users and Learn. It does not expose product-level user data like learning and performance records.

Technical overview

The UM API is a read and write, REST-based API providing both generic and SCIM-compliant endpoints. It uses standard HTTP requests and returns JSON-formatted responses.

Generic endpoints

Supports OData-like query parameters. Some query parameter limitations are detailed on a per endpoint basis.

For large responses, the API uses server-driven pagination and supports an OData-like $skip query parameter. While the number of records per page varies by endpoint, a nextpagelink property is returned in the response to retrieve the next page of results.

SCIM endpoints

Implemented in accordance to SCIM 2.0 standard (RFC 7642, 7643, 7644). Some query parameter limitations are detailed on a per endpoint basis.

For large responses, the API uses index-based pagination and supports itemsPerPage and startIndex query parameters. All endpoints are defaulted and limited to 50 records per page.