--- title: Peakon SCIM API Integration on Truto slug: peakonscim category: Voice canonical: "https://truto.one/integrations/detail/peakonscim/" --- # Peakon SCIM API Integration on Truto **Category:** Voice **Status:** Beta ## Unified APIs ### Unified User Directory API - **Users** — The User object represents a User. ## How it works 1. **Link your customer's Peakon SCIM account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Peakon SCIM.** The Proxy API is a 1-to-1 mapping of the Peakon SCIM API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Automate employee provisioning into Peakon on day one** — SaaS onboarding and IT orchestration platforms can automatically create user accounts in their customers' Peakon instances the moment a new hire appears in the source HR system, ensuring employees are correctly segmented for engagement surveys from their start date. - **Reclaim unused Peakon licenses through activity-based deprovisioning** — License management and SaaS spend optimization platforms can pull the full Peakon user directory, cross-reference it with actual usage data, and deactivate dormant accounts — helping customers recover costly Enterprise-tier seats. - **Keep org structures in sync across HR tools and Peakon** — People analytics and employee experience platforms need Peakon's identity data (department, manager, location) to match their own org charts. Syncing the user directory ensures survey segmentation and internal reporting always reflect the same organizational reality. - **Instantly revoke Peakon access during offboarding** — Security and identity governance platforms can trigger immediate deactivation of a terminated employee's Peakon account as part of an automated offboarding workflow, closing access gaps and protecting historical survey data. - **Enrich a centralized employee directory with Peakon identity data** — IT dashboard and directory consolidation products can pull user records from Peakon to build a unified view of all SaaS identities across a customer's stack, enabling shadow-IT detection and cross-platform identity auditing. ## What you can build - **Zero-touch new hire survey enrollment** — Automatically provision new employees into Peakon with full attribute mapping (department, manager, hire date, location) so they're segmented into the correct engagement surveys from day one. - **Dormant license detection and reclamation dashboard** — Surface inactive Peakon users by syncing the full user directory and let IT admins deactivate them in bulk to optimize Enterprise license spend. - **Real-time offboarding access revocation** — Instantly set departing employees to inactive in Peakon as part of an automated termination workflow, ensuring zero lingering access. - **Cross-platform org chart reconciliation** — Continuously sync manager, department, and location attributes from Peakon's user directory to detect and flag discrepancies against your customers' primary HRIS. - **Bulk attribute update pipeline for restructures** — Push department transfers, manager changes, and location updates to Peakon in bulk when a customer undergoes a reorg, keeping survey targeting accurate without manual CSV uploads. - **Unified employee identity audit log** — Ingest and timestamp every user record change synced from Peakon to build a searchable audit trail of provisioning and deprovisioning events across all connected SaaS tools. ## FAQs ### How does authentication work with Peakon's SCIM API? Peakon SCIM uses Bearer Token authentication. A Peakon admin generates the token from the admin console. Truto manages token storage and injection so your application never handles raw credentials directly. ### What operations are supported on Peakon's SCIM Users endpoint? Peakon supports full SCIM 2.0 CRUD operations on the /Users endpoint: GET (list and retrieve), POST (create), PUT (full replace), PATCH (partial update, including setting active to false), and DELETE. Truto maps these through the Unified User Directory API. ### Does Peakon SCIM support group synchronization? No. Peakon's SCIM implementation does not support the /Groups endpoint. Survey segmentation must be achieved entirely through custom user attributes like Department, Manager ID, and Location pushed on individual user records. ### What custom attributes can be synced to Peakon user records? You can map enterprise-specific attributes including Department, Manager ID, Date of Birth, Gender, Tenure/Hire Date, Location, and Employee Number. These attributes are critical because they are the only mechanism Peakon uses to dynamically group users for survey analytics. ### Is Peakon SCIM available on all Peakon plans? No. SCIM access is gated behind Peakon's Enterprise tier, which typically starts around $20,000/year. Your end users will need to confirm they are on the Enterprise plan before they can connect their Peakon instance. ### How does Truto handle pagination for Peakon SCIM? Peakon uses cursor-based pagination on the /Users endpoint. Truto abstracts this entirely — your application receives a complete, unified response without needing to implement pagination logic specific to Peakon's SCIM API.