Este documento mostra como configurar o Microsoft Entra ID para provisionar automaticamente contas de usuário na Workvivo usando APIs SCIM 2.0. O guia destaca como adicionar a Workvivo como um aplicativo corporativo, configurar o URL do locatário de provisionamento e do token secreto, desativar o provisionamento em grupo, configurar o mapeamento de atributos do usuário, adicionar atributos personalizados e iniciar a sincronização de provisionamento. Também orienta a entrar em contato com o suporte da Workvivo para obter ajuda em domínios ou erros.
Este documento fornece diretrizes sobre como configurar o sistema de gerenciamento de identidades Entra ID da Microsoft para provisionar automaticamente contas de usuário para o Workvivo por meio de um protocolo padrão do setor chamado Sistema de Gerenciamento de Usuários entre Domínios (System for Cross-domain Identity Management -SCIM).
O Workvivo dá suporte ao provisionamento automático de usuários via uma série de APIs RESTful JSON compatíveis com SCIM 2.0.
Neste documento, você aprenderá a configurar o Entra ID para provisionar usuários para o Workvivo usando essas APIs.
Se preferir um passo a passo em vídeo, pule para esta seção.
Importante: se estiver fazendo uma migração do Meta Workplace, NÃO provisione nenhum usuário até que a migração seja concluída.
1. Adicionando o Workvivo como um aplicativo corporativo no Entra ID
O primeiro passo para configurar o Workvivo no Entra AD é configurar o Workvivo como um aplicativo corporativo usando o portal Entra ID.
Confira nosso artigo sobre Microsoft Entra ID – Logon único e siga o passo 1 para adicionar o Workvivo como um aplicativo empresarial.
Se você já configurou o Workvivo como um aplicativo no Entra ID para fins de logon único, pode pular esta etapa e ir diretamente para o aplicativo Workvivo existente no Entra ID.
2. Configurando URL do locatário de provisionamento e token secreto
Navegue até o aplicativo Workvivo Enterprise que você criou na sua instância do Entra ID.
No lado esquerdo, na lista de subnavegação "Gerenciar", clique em "Provisionamento" para ir para a tela de configuração de provisionamento.
Por padrão, o "Modo de Provisionamento" é definido como "Manual". Altere este campo para "Automático" e uma série de novos campos aparecerão na tela. O primeiro passo é inserir as credenciais de administrador para a API SCIM do Workvivo.
Em "URL do locatário", insira o seguinte:
https://[seudominioworkvivo]/azure/v2/scim
Em que "seudomínioworkvivo" é o nome do domínio da sua instância Workvivo, por exemplo https://[nomedaempresa].workvivo[.com][.us][.me]
*Observação: dependendo se sua instância do Workvivo estiver hospedada em nosso data center na UE, EUA ou Emirados Árabes Unidos, certifique-se de inserir o domínio correto. Será workvivo.com, workvivo.us, ou workvivo.me. O formato também pode ser diferente se sua organização tiver configurado um nome de domínio personalizado para o Workvivo. Se você não souber seu nome de domínio Workvivo, entre em contato com nossa equipe de suporte em support@workvivo.com para obter assistência. Pressione o botão “Salvar” para continuar.
Em "Token secreto", gere o token diretamente no Painel de administração > Configurações de provisionamento. Você precisará da função Administrador de TI, que pode ser adicionada por um usuário admin atual:
Escolha "Outro" no menu suspenso Provedor de SCIM. Esteja ciente de que não é possível recuperar esse token. Se você o perder, será necessário gerar e configurar um novo token no Entra ID.
Depois de gerado, você pode adicionar o token no Entra ID. Pressione o botão "Testar conexão" – o Entra ID deverá responder com uma mensagem de sucesso. Agora pressione o botão "Salvar" na parte superior da tela - mais uma vez, o Entra ID deverá responder com uma mensagem de sucesso.
3. Desabilitando 'Provisionar Grupos de IDs de Entrada da Microsoft'
Neste ponto, deve haver dois registros exibidos na seção Mapeamentos, conforme mostrado abaixo:
Para a maioria dos clientes, não precisamos sincronizar grupos de ID Entra, pois podemos obter os dados de equipe relevantes necessários para o Workvivo diretamente do recurso do usuário. Clique em "Provisionar Grupos de IDs de Entrada da Microsoft" para editar os mapeamentos para Grupos de IDs de Entrada.
Na tela que se abre, em "Habilitado", clique em "Não" para desabilitar o provisionamento de Grupos de ID Entra e clique no botão "Salvar" na parte superior da tela. Clique em "Sim" para confirmar suas alterações.
Quando isso estiver concluído, clique no "X" no canto superior direito da janela para fechar a tela Mapeamento de Atributos e retornar à tela anterior. Você deverá ver "Não" na coluna "Habilitado" para Grupos de ID de entrada na seção Mapeamentos.
4. Configurar os mapeamentos de usuários do Entra ID
O último passo é confirmar os mapeamentos dos usuários do Entra ID. Clique em "Provisionar usuários do Microsoft Entra ID" para abrir a tela "Mapeamento de atributos" para usuários do Entra ID. Em "Mapeamentos de Atributos", verifique se os atributos do Entra ID que estão sendo mapeados são os corretos para a sua organização. Na maioria dos casos, as opções padrão devem ser suficientes.
A seguir estão os atributos "Customappsso" usados no Workvivo e como eles são usados:
-
externalId
Utilizado pelo provisionamento SCIM como identificador único para determinar o momento de adicionar ou atualizar usuários no Workvivo. Por padrão, esse valor é definido como mailNickname. No entanto, se os usuários não tiverem um mailNickname exclusivo, recomendamos alterar o atributo de origem para um valor mais individual, como objectID ou userPrincipalName.
-
userName*
Mapeamos isso para o e-mail no Workvivo. Por padrão, é definido como "userPrincipalName" no Entra ID. Se o valor desse atributo não for um endereço de e-mail na sua organização, você deve usar um atributo diferente aqui (por exemplo, "mail").
-
emails[type eq "work"].value*
Mapeamos isso para o e-mail no Workvivo. Por padrão, é definido como "userPrincipalName" no Entra ID. Se o valor desse atributo não for um endereço de e-mail na sua organização, você deve usar um atributo diferente aqui (por exemplo, "mail").
*É muito importante que userName e emails[type eq "work"].value sejam mapeados para o mesmo valor.
-
name.givenName
O nome do usuário.
-
name.familyName
O sobrenome do usuário.
-
title
O cargo do usuário.
-
phoneNumbers[type eq "mobile"].value
O número de celular do usuário; esse campo é opcional no Workvivo.
-
phoneNumbers[type eq "work"].value
O número da discagem direta do usuário; esse campo é opcional no Workvivo.
-
active
Se a conta do usuário deve estar ativa ou não.
-
department
O departamento do usuário. Isso será configurado como uma equipe no Workvivo. Se ainda não existir, será criada e o usuário será automaticamente atribuído. Será mapeado para a equipe principal no Workvivo Adv Analytics.
-
addresses[type eq "work"].locality
A localização do usuário (o padrão é “cidade” no Entra ID). Isso será configurado como uma equipe no Workvivo. Se ainda não existir, será criada e o usuário será atribuído automaticamente. Será mapeado para a equipe secundária no Workvivo Adv Analytics.
- urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter - este não é um mapeamento padrão, você precisará adicioná-lo como um atributo adicional. Isso será mapeado para a Equipe Terciária no Workvivo Adv Analytics
Comunique ao seu contato da Workvivo quais são suas equipes primárias, secundárias e terciárias preferenciais para que essas informações possam ser configuradas primeiro no Workvivo.
Novamente, a maioria das organizações não precisa alterar os mapeamentos padrão, mas você pode fazer isso se desejar usar atributos de ID Entra diferentes para o campo Workvivo fornecido (por exemplo, use um atributo diferente para localização que não seja "cidade").
Quando estiver satisfeito com os mapeamentos, clique no botão "X" para fechar a janela.
5. Atributos adicionais
Se você quiser mapear atributos adicionais, siga a sintaxe abaixo.
Em Mapeamento de Atributos – escolha Mostrar opções avançadas - Editar lista de atributos para customappsso
A partir daqui você pode editar a Lista de Atributos.
Data de contratação:
urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:hireDate – o valor precisa ser AAAA-MM-DD
Data de nascimento:
urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:dateOfBirth – o valor precisa ser AAAA-MM-DD
Centro de Custo:
Primeiro, você precisará informar ao seu contato da Workvivo o nome do tipo de equipe terciária do seu centro de custo (por exemplo, Escritório, Locatário, País)
urna:ietf:parâmetros:scim:esquemas:extensão:empresa:2.0:Usuário:costCenter
Tipos de equipes personalizadas:
Primeiro, você precisará informar ao seu contato da Workvivo o nome dos tipos de equipe adicionais (por exemplo, Escritório, Locatário, País)
urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:wvtax_TeamTypeName por exemplo: urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:wvtax_Office
Campos personalizados:
Primeiro, você precisará informar ao seu contato da Workvivo o nome dos seus campos adicionais (por exemplo, Pronomes, Número do funcionário)
urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:CustomFieldName, por exemplo urn:ietf:params:scim:schemas:extension:workvivo:2.0:Usuário:Pronomes
Funções de autenticação:
Se você quiser provisionar funções de usuário, use a seguinte sintaxe:
urna:ietf:params:scim:schemas:extensão:workvivo:2.0:Usuário:authRoles
Valor: administrador, moderador de espaço
6. Iniciar a sincronização de provisionamento
A configuração de provisionamento está concluída. Se quiser testar primeiro, provisione alguns usuários para garantir que estejam sendo transferidos corretamente. Antes de prosseguir com isso, o usuário deve ser adicionado aos usuários/grupos.
Após o teste bem-sucedido, você pode clicar em "Iniciar provisionamento" na seção de visão geral.
A sincronização inicial pode levar até uma hora, dependendo de quantos usuários estão no escopo.
O Entra ID normalmente provisiona dados a cada 20 a 40 minutos, embora isso possa variar dependendo do número de usuários na sua instância do Entra ID.
Nesse ponto, você pode notificar seu contato do Workvivo de que iniciou o processo de provisionamento no Entra ID. Ele pode verificar nossos logs internos relevantes para garantir que o processo esteja funcionando como esperado. Quando o processo de provisionamento começar a funcionar, você pode revisar os logs de provisionamento no Entra ID.
Em caso de problemas com o provisionamento, você verá informações sobre os erros nos logs. No entanto, eles não são muito úteis. Por isso, se houver erros, peça ajuda à Workvivo. Temos um registro mais útil para diagnosticar quaisquer problemas no provisionamento.