Tutorial: Configurar o Documo para provisionamento automático de usuários

Este tutorial descreve as etapas que você precisa executar no Documo e no Microsoft Entra ID para configurar o provisionamento automático de usuários. Quando configurado, o Microsoft Entra ID provisiona e desprovisiona automaticamente usuários e grupos para o Documo usando o serviço de provisionamento do Microsoft Entra. Para obter detalhes importantes sobre o que esse serviço faz, como funciona e perguntas frequentes, consulte Automatizar o provisionamento e o desprovisionamento de usuários para aplicativos SaaS com o Microsoft Entra ID.

Capacidades suportadas

• Criar usuários no Documo
• Remover usuários no Documo quando eles não precisarem mais de acesso
• Mantenha os atributos do usuário sincronizados entre o Microsoft Entra ID e o Documo
• Logon único no Documo (recomendado).

Pré-requisitos

O cenário descrito neste tutorial pressupõe que você já tenha os seguintes pré-requisitos:

• Um locatário do Microsoft Entra
• Uma das seguintes funções: Administrador de Aplicativos, Administrador de Aplicativos na Nuvem ou Proprietário de Aplicativos.
• Uma conta Documo com acesso à API.
• Uma conta de usuário no Documo com permissões de administrador.

Etapa 1: Planejar a implantação do provisionamento

1. Saiba como funciona o serviço de aprovisionamento.
2. Determine quem vai estar no âmbito do aprovisionamento.
3. Determine quais dados mapear entre o Microsoft Entra ID e o Documo.

Etapa 2: Configurar o Documo para dar suporte ao provisionamento com o ID do Microsoft Entra

1. Gere uma chave de API para usar no provisionamento do Microsoft Entra.
2. Encontre e lembre-se do URL da API. O URL da API padrão é https://api.documo.com. Se você tiver um domínio personalizado da API do Documo, poderá consultá-lo na guia domínio da página de configurações de identidade visual do Documo.

Etapa 3: Adicionar Documo da galeria de aplicativos do Microsoft Entra

Adicione o Documo da galeria de aplicativos do Microsoft Entra para começar a gerenciar o provisionamento no Documo. Se você configurou anteriormente o Documo para SSO, você pode usar o mesmo aplicativo. No entanto, é recomendável criar uma aplicação separada ao testar a integração inicialmente. Saiba mais sobre como adicionar uma aplicação a partir da galeria aqui.

Etapa 4: Definir quem estará no escopo do provisionamento

O serviço de provisionamento do Microsoft Entra permite definir o escopo de quem será provisionado com base na atribuição ao aplicativo e/ou com base nos atributos do usuário/grupo. Se optar por determinar quem vai ser aprovisionado na sua aplicação com base na atribuição, pode utilizar os seguintes passos para atribuir utilizadores e grupos à aplicação. Se escolher determinar quem vai ser aprovisionado com base apenas em atributos do utilizador ou grupo, pode utilizar um filtro de âmbito conforme descrito aqui.

• Comece pequeno. Teste com um pequeno conjunto de utilizadores e grupos antes de implementar para todos. Quando o âmbito do aprovisionamento está definido para os utilizadores e os grupos atribuídos, pode controlar isto ao atribuir um ou dois utilizadores ou grupos à aplicação. Quando o âmbito está definido para todos os utilizadores e grupos, pode especificar um filtro de âmbito baseado em atributos.

• Se precisar de funções adicionais, você pode atualizar o manifesto do aplicativo para adicionar novas funções.

Etapa 5: Configurar o provisionamento automático de usuários para o Documo

Esta seção orienta você pelas etapas para configurar o serviço de provisionamento do Microsoft Entra para criar, atualizar e desabilitar usuários e/ou grupos no Documo com base em atribuições de usuário e/ou grupo no Microsoft Entra ID.

Para configurar o provisionamento automático de usuários para Documo no Microsoft Entra ID:

1. Entre no centro de administração do Microsoft Entra como pelo menos um administrador de aplicativos na nuvem.

2. Navegue até Aplicativos de identidade>>Aplicativos corporativos

   

3. Na lista de aplicativos, selecione Documo.

   

4. Selecione o separador Aprovisionamento.

   

5. Defina o Modo de Aprovisionamento como Automático.

   

6. Na seção Credenciais de administrador, insira o URL do locatário do Documo e o token secreto.

   • O URL do locatário é o URL da API que você preparou na Etapa 2 com /scim/v2 anexado ao final. O valor para aqueles sem domínios personalizados deve ser https://api.documo.com/scim/v2.

   • No campo Token secreto, copie e cole a chave da API que você preparou na Etapa 2. Clique em Testar Conexão para garantir que o Microsoft Entra ID possa se conectar ao Documo. Se a conexão falhar, verifique se sua conta do Documo tem permissões de administrador e tente novamente.

   

7. No campo E-mail de Notificação, introduza o endereço de e-mail de uma pessoa ou um grupo que deve receber as notificações de erro de aprovisionamento e marque a caixa de verificação Enviar uma notificação de e-mail quando ocorre uma falha.

   

8. Selecione Guardar.

9. Na seção Mapeamentos, selecione Sincronizar usuários do Microsoft Entra com o Documo.

10. Analise os atributos de usuário sincronizados do ID do Microsoft Entra para o Documo na seção Mapeamento de Atributos. Os atributos selecionados como propriedades correspondentes são usados para corresponder às contas de usuário no Documo para operações de atualização. Se você optar por alterar o atributo de destino correspondente, precisará garantir que a API do Documo ofereça suporte à filtragem de usuários com base nesse atributo. Selecione o botão Salvar para confirmar as alterações.

    Atributo	Type	Suportado para filtragem
    nome de utilizador	String	✓
    active	Boolean
    name.givenName	String
    name.familyName	String
    roles[primary eq "True"].value	String

11. Para configurar filtros de âmbito, veja as instruções seguintes disponibilizadas no Tutorial de filtro de âmbito.

12. Para habilitar o serviço de provisionamento do Microsoft Entra para Documo, altere o Status de provisionamento para Ativado na seção Configurações.

    

13. Defina os usuários e/ou grupos que você gostaria de provisionar para o Documo escolhendo os valores desejados em Escopo na seção Configurações.

    

14. Quando estiver pronto para aprovisionar, clique em Guardar.

    

Esta operação inicia o ciclo de sincronização inicial de todos os utilizadores e grupos definidos no Âmbito na secção Definições. O ciclo inicial leva mais tempo para ser executado do que os ciclos subsequentes, que ocorrem aproximadamente a cada 40 minutos, enquanto o serviço de provisionamento do Microsoft Entra estiver em execução.

Etapa 6: Monitorar sua implantação

Depois de configurar o aprovisionamento, utilize os seguintes recursos para monitorizar a sua implementação:

• Utilize os registos de aprovisionamento para determinar quais os utilizadores que foram aprovisionados com ou sem êxito
• Verifique a barra de progresso para ver o estado do ciclo de aprovisionamento e quão próximo está da conclusão
• Se a configuração de aprovisionamento parecer estar num mau estado de funcionamento, a aplicação vai entrar em quarentena. Saiba mais sobre os estados de quarentena aqui.

Mais recursos

• Gerir o aprovisionamento de contas de utilizador para Aplicações Empresariais
• O que é acesso ao aplicativo e logon único com o Microsoft Entra ID?

Próximos passos

• Saiba como analisar os registos e obter relatórios sobre a atividade de aprovisionamento