Skip to main content
Peakon
Last Updated: 2025-01-24
Reference: Peakon SCIM 2.0 API Payload

Reference: Peakon SCIM 2.0 API Payload

This topic lists the required and optional attributes for creating or updating user profiles in SCIM-compliant systems. It outlines the schemas and attributes, such as
userName
,
name
,
locale
, and
timezone
, which you must define at the payload's top level. It also provides information on optional attributes like
employeeNumber
under the enterprise schema and additional user-specific details like
Gender
,
Age
,
Region
, and
Job Title
under the Peakon schema.
Payload
Criteria
{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User", "urn:ietf:params:scim:schemas:extension:peakon:2.0:User" ],
Required. These are the schemas you need to define at the beginning of the payload.
"userName": "janesmith@kinetar-example.com", "name": { "givenName": "Jane", "familyName": "Smith" },
Required for creation. Optional for update.
userName
(email),
name
(comprised of givenName and familyName),
locale
,
timezone
, etc. to be set at top level.
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "E5697586" },
Optional for creation and update (if
userName
is present). Include
employeeNumber
under the schema
"urn:..:extension:
enterprise
:2.0:User"
.
"urn:ietf: params:scim:schemas:extension:peakon:2.0:User": { "Gender": "Male", "Age": "1988-06-22", "Tenure": "2019-05-25", "Region": "EMEA", "Manager": "mcardoza@kinetar-example.com", "Business Unit": "CHRO", "Department": "Benefits", "Job title": "Senior Benefits Analyst", "Separation Date": "2020-06-07" }
Optional for creation and update. Include any other attributes under the schema
"urn:..:extension:
peakon
:2.0:User"
.