Saltar al contenido principal
Peakon
Última actualización: 2025-01-24
Concepto: API Peakon SCIM 2.0

Concepto: API Peakon SCIM 2.0

La API de Peakon automatiza el aprovisionamiento y desaprovisionamiento de empleados, lo que garantiza que la participación en la encuesta de Peakon se alinee con los sistemas que admiten el protocolo SCIM 2.0, como Microsoft Azure Active Directory, Okta y OneLogin. Este método permite que varios sistemas actualicen y sincronicen los registros de los empleados.

Acerca de SCIM 2.0

El sistema para la gestión de identidad entre dominios (SCIM) 2.0 especifica un protocolo REST estandarizado para el aprovisionamiento unidireccional de usuarios a través de HTTP. Su sistema de gestión de identidad existente se puede configurar para sincronizar automáticamente los cambios realizados en su base de datos con una aplicación de terceros como Peakon. En el protocolo SCIM, el sistema central de gestión de identidad se denomina "proveedor de identidad" y la aplicación de terceros se denomina "proveedor de servicios". Al configurar Peakon como proveedor de servicios con su sistema de gestión de identidad existente, su organización podrá aprovechar al máximo el aprovisionamiento automático de cuentas.
Para obtener instrucciones sobre cómo configurarlo, visite Configurar el aprovisionamiento de empleados mediante SCIM 2.0.

Operaciones apoyadas

La API de Peakon SCIM 2.0 admite estas operaciones:
  • Crear usuarios
  • Actualizar usuarios
  • Eliminar usuarios
  • Activar/desactivar usuarios
  • Operaciones masivas para usuarios

Extensión del esquema empresarial

Peakon admite los siguientes atributos básicos en la extensión de esquema de usuario empresarial, tal como se define en la especificación SCIM 2.0:
  • número de empleado
  • Departamento
  • Supervisor
El esquema de su empresa contiene el esquema de usuario empresarial de su empresa y las extensiones de esquema de Peakon. Para recuperar los esquemas compatibles con su empresa, incluidos los campos disponibles, llame al punto final
Obtener esquemas
.

Extensión del esquema Peakon

Además de los campos básicos, Peakon proporciona una extensión de esquema personalizada para permitir datos de campo para atributos personalizados (por ejemplo,
Gerente
,
Fecha de nacimiento
,
Departamento
, etc.). El formato de esta extensión sigue el formato especificado en la especificación SCIM 2.0.
El tipo de valor de los atributos personalizados depende del tipo de atributo:
Tipo de atributo
Tipo de valor
Atributos de tipo de opción.
Ejemplo:
Departamento
.
Un valor de cadena (máximo 256 caracteres).
Atributos de tipo fecha.
Ejemplo:
Fecha de nacimiento
.
Una cadena
de fecha y hora
(formato ISO 8601).
Atributos de tipo número.
Ejemplo:
Salario
.
Un valor entero.
Atributo de tipo de empleado.
Ejemplo:
Gerente
.
Un valor de cadena que contiene el correo electrónico del empleado al que se hace referencia. Dado que los atributos de tipo de empleado hacen referencia a otros empleados en el sistema, el empleado referenciado debe existir en el sistema de antemano. Puede hacer esto con un aprovisionamiento de dos pasos, incluyendo solo campos básicos en el primer paso y campos extendidos en el segundo.
Los atributos personalizados se proporcionan como un subobjeto de los campos de recursos principales. Ejemplo:
{ “name” : { “firstName”: “Jane”, “lastName”: “Smith” }, “urn:ietf:params:scim:schemas:extension:peakon:2.0:User”: { “Business Unit”: “Engineering”, “Department”: “IT” } }
Para recuperar los esquemas compatibles con su empresa, incluidos los campos disponibles, llame al punto final
Obtener esquemas
.

Carga útil

Limitación de velocidad

La API SCIM de Peakon tiene una velocidad limitada a 25 000 operaciones por hora. Una solicitud de API SCIM masiva consume 1 operación por operación en la carga útil de la solicitud. Otras solicitudes de API de SCIM consumen 1 operación. Cualquier integración debe limitar sus llamadas API para asegurarse de que no se exceda este límite.