Skip to main content
Documentation
Documentation
Peakon
Last Updated: 2025-01-24
Concept: Peakon SCIM 2.0 API

Concept: Peakon SCIM 2.0 API

Peakon's API automates employee provisioning and de-provisioning, ensuring Peakon survey participation aligns with systems that support the SCIM 2.0 protocol, such as Microsoft Azure Active Directory, Okta, and OneLogin. This method allows multiple systems to update and sync employee records.

About SCIM 2.0

System for Cross-domain Identity Management (SCIM) 2.0 specifies a standardized REST protocol for unidirectional provisioning of users over HTTP. Your existing identity management system can be configured to automatically synchronize changes made to its database to a third party application like Peakon. In the SCIM protocol, the central identity management system is called the "identity provider" and the third party application is called a "service provider". By configuring Peakon as a service provider with your existing identity management system, your organization will be able to take full advantage of automatic account provisioning.
For instructions on how to set it up, visit Set Up Employee Provisioning Using SCIM 2.0.

Supported Operations

Peakon SCIM 2.0 API supports these operations:
  • Create users
  • Update users
  • Delete users
  • Activate/deactivate users
  • Bulk operations for users

Enterprise Schema Extension

Peakon supports the following basic attributes in the Enterprise user schema extension, as defined in the SCIM 2.0 specification:
  • employeeNumber
  • Department
  • Manager
The schema for your company contains your company's Enterprise user schema and Peakon schema extensions. To retrieve the schemas that are supported for your company, including available fields, call the
Get schemas
 endpoint.

Peakon Schema Extension

In addition to the basic fields, Peakon provides a custom schema extension to allow field data for custom attributes (e.g.
Manager
,
Date of Birth
,
Department
, etc.). The format of this extension follows the format specified in the SCIM 2.0 specification.
The value type of the custom attributes depend of the type of attribute:
Attribute Type
Value Type
Option type attributes.
Example:
Department
.
A string value (max 256 characters).
Date type attributes.
Example:
Date of Birth
.
A
DateTime
 string (ISO 8601 format).
Number type attributes.
Example:
Salary
.
An Integer value.
Employee type attribute.
Example:
Manager
.
A string value containing the email of the referenced employee. Since employee type attributes reference other employees in the system, the referenced employee needs to exist in the system beforehand. You can do this with a two-step provisioning, including only basic fields in the first step and extended fields in the second.
Custom attributes are provided as a sub-object of the main resource fields. Example: 
{
“name” : {
“firstName”: “Jane”,
“lastName”: “Smith”
},
“urn:ietf:params:scim:schemas:extension:peakon:2.0:User”: {
“Business Unit”: “Engineering”,
“Department”: “IT”
}
}
To retrieve the schemas that are supported for your company, including available fields, call the
Get schemas
 endpoint.

Payload

Visit Reference: Peakon SCIM 2.0 API Payload for more information.

Rate Limiting

The Peakon SCIM API is rate limited at 25,000 operations/hour. A bulk SCIM API request consumes 1 operation per operation in the request payload. Other SCIM API requests consume 1 operation. Any integration should throttle its API calls to make sure this limit is not exceeded.