Ir para o conteúdo principal
Documentação
Documentação
Peakon
Última atualização: 2025-01-24
Conceito: API Peakon SCIM 2.0

Conceito: API Peakon SCIM 2.0

A API da Peakon automatiza o provisionamento e o desprovisionamento de funcionários, garantindo que a participação na pesquisa da Peakon esteja alinhada com sistemas que oferecem suporte ao protocolo SCIM 2.0, como Microsoft Azure Active Directory, Okta e OneLogin. Este método permite que vários sistemas atualizem e sincronizem registros de funcionários.

Sobre o SCIM 2.0

O Sistema para Gerenciamento de Identidade entre Domínios (SCIM) 2.0 especifica um protocolo REST padronizado para provisionamento unidirecional de usuários via HTTP. Seu sistema de gerenciamento de identidade existente pode ser configurado para sincronizar automaticamente as alterações feitas em seu banco de dados com um aplicativo de terceiros, como o Peakon. No protocolo SCIM, o sistema central de gerenciamento de identidade é chamado de "provedor de identidade" e o aplicativo de terceiros é chamado de "provedor de serviços". Ao configurar o Peakon como um provedor de serviços com seu sistema de gerenciamento de identidade existente, sua organização poderá aproveitar ao máximo o provisionamento automático de contas.
Para obter instruções sobre como configurá-lo, visite Configurar o provisionamento de funcionários usando o SCIM 2.0.

Operações Suportadas

A API Peakon SCIM 2.0 suporta estas operações:
  • Criar usuários
  • Atualizar usuários
  • Excluir usuários
  • Ativar/desativar usuários
  • Operações em massa para usuários

Extensão de Esquema Empresarial

O Peakon oferece suporte aos seguintes atributos básicos na extensão de esquema do usuário corporativo, conforme definido na especificação SCIM 2.0:
  • employeeNumber
  • Departamento
  • Gestor
O esquema da sua empresa contém o esquema do usuário corporativo e as extensões de esquema Peakon da sua empresa. Para recuperar os esquemas suportados pela sua empresa, incluindo os campos disponíveis, chame o endpoint
Obter esquemas
 .

Extensão de esquema Peakon

Além dos campos básicos, o Peakon fornece uma extensão de esquema personalizada para permitir dados de campo para atributos personalizados (por exemplo,
Gerente
,
Data de Nascimento
,
Departamento
, etc.). O formato desta extensão segue o formato especificado na especificação SCIM 2.0.
O tipo de valor dos atributos personalizados depende do tipo de atributo:
Tipo de atributo
Tipo de valor
Atributos do tipo de opção.
Exemplo:
Departamento
.
Um valor de sequência de caracteres (máximo de 256 caracteres).
Atributos do tipo de data.
Exemplo:
Data de Nascimento
.
Uma sequência
de data e hora
 (formato ISO 8601).
Atributos do tipo numérico.
Exemplo:
Salário
.
Um valor inteiro.
Atributo de tipo de funcionário.
Exemplo:
Gerente
.
Um valor de sequência de caracteres contendo o e-mail do funcionário referenciado. Como os atributos do tipo de funcionário fazem referência a outros funcionários no sistema, o funcionário referenciado precisa existir no sistema previamente. Você pode fazer isso com um provisionamento em duas etapas, incluindo apenas campos básicos na primeira etapa e campos estendidos na segunda.
Atributos personalizados são fornecidos como um subobjeto dos campos de recursos principais. Exemplo: 
{
“name” : {
“firstName”: “Jane”,
“lastName”: “Smith”
},
“urn:ietf:params:scim:schemas:extension:peakon:2.0:User”: {
“Business Unit”: “Engineering”,
“Department”: “IT”
}
}
Para recuperar os esquemas suportados pela sua empresa, incluindo os campos disponíveis, chame o endpoint
Obter esquemas
 .

Carga útil

Visita Referência: Carga útil da API Peakon SCIM 2.0 para maiores informações.

Limitação de taxa

A API SCIM do Peakon tem uma taxa limitada a 25.000 operações/hora. Uma solicitação em massa da API SCIM consome 1 operação por operação no payload da solicitação. Outras solicitações da API SCIM consomem 1 operação. Qualquer integração deve limitar suas chamadas de API para garantir que esse limite não seja excedido.