Como integrar o ADManager Plus e o ADP Workforce

O ADP usa o OAuth 2.0 para autorizar solicitações de API.

Ele requer um client_id e client_secret para autorização.

Privilégios

Para importar usuários (ação de entrada): Certifique-se de que a conta usada para autorização tenha permissão para ler todas as contas de usuário.

Para executar qualquer ação ou consulta no ADP (ação de saída): Certifique-se de que a conta usada para autorização tenha permissão para executar a ação desejada.

Configuração de autorização

• Faça login no ADManager Plus e navegue até Directory/Application Settings.
• Vá para Application Integrations e, em seguida, pesquise e selecione ADP.
• Ative o botão Enable ADP Integration.
• Na página ADP Configuration, clique em Authorization.
• Selecione Client Credentials como o Grant Type.
• Execute as etapas para gerar um client_id e client_secret do ADPe cole-os nos respectivos campos de valor.
• Em Advanced Options, carregue o certificado e o arquivo de chave gerados no lado do ADP e forneça a frase secreta se o certificado for protegido por senha.
• Clique em Configure.

Configuração do webhook de entrada

Um webhook de entrada permite buscar dados de usuário do ADP Workforce para o ADManager Plus. O mapeamento de atributos configurado nesta seção pode ser selecionado como a fonte de dados durante a configuração da automação para executar a ação desejada na lista de usuários recebida da resposta da API. Para configurar um webhook de entrada para o ADP Workforce:

• Em Inbound Webhook, clique em ADP Workforce Endpoint Configuration.
• Na aba Endpoint Configuration um endpoint, ADP Workforce USERS ENDPOINT, vem pré-configurado com campos Endpoint URL, API Method, Headers, e Parameters para buscar contas de usuários do ADP Workforce. No entanto, se desejar usar um novo endpoint para importar usuários, você pode configurar um usando o botão + Add API endpoint e preenchendo os campos necessários de acordo com as referências de API do ADP Workforce. Clique aqui para saber como.

  Observação:

  • O par de valores de chave de API é pré-configurado como um cabeçalho para autenticar solicitações de API, conforme configurado durante a Authorization Configuration.
  • Macros: Você pode adicionar macros à configuração de seu endpoint para mudá-lo dinamicamente conforme suas necessidades usando o componente de seleção de macros.
  • Consulte as referências de API do ADP Workforce e configure cabeçalhos e parâmetros adicionais, se necessário.
• Quando terminar, clique em Test & Save. Uma janela de resposta exibirá todos os parâmetros solicitados que podem ser obtidos usando a chamada de API. Clique em Proceed.

  Observação:

  • Consulte as referências de API do ADP Workforce para saber quais Parameters devem ser configurados para obter apenas parâmetros específicos.
  • Você pode configurar vários endpoints para o ADP Workforce usando o botão + Add API endpoint Clique aqui para saber como.
• Clique em Data Source - LDAP Attribute Mapping para corresponder endpoints e mapear os atributos LDAP do AD com os respectivos atributos no ADP Workforce.
• Clique em + Add New Configuration e faça o seguinte:
  • Digite o Configuration Name e a Description e selecione a Automation Category no menu suspenso.
  • No campo Select Endpoint, selecione o endpoint desejado e uma Primary Key que seja exclusiva de um usuário (por exemplo, employeeIdentifier).
  Observação: Quando vários endpoints são configurados, esse atributo deve ter o mesmo valor em todos os endpoints.
  • No campo Attribute Mapping, selecione o atributo no menu suspenso LDAP Attribute Name e mapeie-o com a respectiva coluna no ADP Workforce.
  • Se você quiser criar um novo formato personalizado para isso, clique em Add New Format.
  • Clique em Save.
  .

Configuração do webhook de saída

O webhook de saída permite que você atualize as mudanças feitas no AD usando o ADManager Plus para o ADP e sincronize-as com o AD. Para configurar um webhook de saída para o ADP:

• Em Outbound Webhook, clique em ADP Webhook Configuration.
• Clique em+ Add Webhook.
• Digite um nome e uma descrição para esse webhook.
• Decida a ação que deve ser executada e consulte a documentação de API do ADP para obter os detalhes da API, como URL, cabeçalhos e parâmetros.
• Selecione o método HTTP que permitirá que você execute a ação desejada no endpoint no menu suspenso.
• Digite o URL do endpoint.
• Configure Headers, Parameters, e Message Type no formato apropriado com base na chamada de API que você gostaria de executar..
• Clique emTest e Save.
• Uma janela pop-up exibirá uma lista de usuários e grupos do AD para testar a chamada de API configurada. Selecione o usuário ou grupo desejado sobre o qual essa solicitação de API deve ser testada e clique em OK. Isso fará uma chamada em tempo real para o URL do endpoint e os objetos selecionados serão modificados de acordo com a configuração.
• A resposta do webhook e os detalhes da solicitação serão exibidos. Verifique se eles correspondem ao comportamento esperado da API e clique em Save.
• Os webhooks configurados podem ser integrados aos Modelos de orquestração- permitindo a automação programada ou orientada por eventos - para executar consecutivamente a ação configurada no webhook de saída entre as ações em um grupo de usuários ou em usuários individuais.
Observação: Use macros para enviar os dados do objeto no qual o webhook é executado