Compartilhar via

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

  • Artigo

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

Funcionalidades com suporte

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

Pré-requisitos

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

Etapa 1: Planeje a implantação do provisionamento

  1. Saiba mais sobre como funciona o serviço de provisionamento.
  2. Determine quem estará no escopo de provisionamento.
  3. Determine os dados que devem ser mapeados entre a ID do Microsoft Entra e o Documo.

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

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

Adicione o Documo por meio da galeria de aplicativos do Microsoft Entra para começar a gerenciar o provisionamento no Documo. Se você já tiver configurado o Documo para SSO, use o mesmo aplicativo. No entanto, recomendamos que você crie um aplicativo diferente ao testar a integração no início. Saiba mais sobre como adicionar um aplicativo da galeria aqui.

Etapa 4: Defina quem estará no escopo de 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 em atributos do usuário/grupo. Se você optar por definir quem estará no escopo de provisionamento com base na atribuição, poderá usar as etapas a seguir para atribuir usuários e grupos ao aplicativo. Se você optar por definir quem estará no escopo de provisionamento com base somente em atributos do usuário ou do grupo, poderá usar um filtro de escopo, conforme descrito aqui.

  • Comece pequeno. Teste com um pequeno conjunto de usuários e grupos antes de implementar para todos. Quando o escopo de provisionamento é definido para usuários e grupos atribuídos, é possível controlar isso atribuindo um ou dois usuários ou grupos ao aplicativo. Quando o escopo é definido para todos os usuários e grupos, é possível especificar um atributo com base no filtro de escopo.

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

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

Esta seção descreve as etapas de configuração do 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 de grupo na ID do Microsoft Entra.

Para configurar o provisionamento automático de usuário para o Documo na ID do Microsoft Entra:

  1. Entre no Centro de administração do Microsoft Entra como pelo menos Administrador de Aplicativo de nuvem.

  2. Navegue até Identidade>Aplicativos>Aplicativos empresariais

    Folha de aplicativos empresariais

  3. Na lista de aplicativos, selecione Documo.

    O link do Documo na lista de Aplicativos

  4. Selecione a guia Provisionamento.

    Guia Provisionamento

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

    Guia Provisionamento automático

  6. Na seção Credenciais de Administrador, insira a URL do Locatário e o Token Secreto do Documo.

    • A URL do locatário é a 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 de API que você preparou na etapa 2. Clique em Testar Conectividade para verificar se a ID do Microsoft Entra pode se conectar ao Documo. Se a conexão falhar, verifique se a sua conta do Documo tem permissões de administrador e tente novamente.

    Token

  7. No campo Notificação por Email, insira o endereço de email de uma pessoa ou grupo que deverá receber as notificações de erro de provisionamento e marque a caixa de seleção Enviar uma notificação por email quando ocorrer uma falha.

    Email de notificação

  8. Clique em Salvar.

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

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

    Atributo Type Com suporte para filtragem
    userName String ✓
    ativo Boolean
    name.givenName String
    name.familyName String
    roles[primary eq "True"].value String

  11. Para configurar filtros de escopo, consulte as seguintes instruções fornecidas no tutorial do Filtro de Escopo.

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

    Status do provisionamento ativado

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

    Escopo de provisionamento

  14. Quando estiver pronto para provisionar, clique em Salvar.

    Salvando a configuração de provisionamento

Essa operação começa o ciclo de sincronização inicial de todos os usuários e grupos definidos no Escopo na seção Configurações. O ciclo inicial leva mais tempo para ser executado do que os ciclos subsequentes, que ocorrem aproximadamente a cada 40 minutos, desde que o serviço de provisionamento do Microsoft Entra esteja em execução.

Etapa 6: Monitorar a implantação

Depois de configurar o provisionamento, use os seguintes recursos para monitorar a implantação:

  • Use os logs de provisionamento para determinar quais usuários foram provisionados com êxito ou não
  • Confira a barra de progresso para ver o status do ciclo de provisionamento e saber como fechá-la para concluir
  • Se a configuração de provisionamento parecer estar em um estado não íntegro, o aplicativo entrará em quarentena. Saiba mais sobre os estados de quarentena aqui.

Mais recursos

Próximas etapas