Compartilhar via

Tutorial: como configurar o Cleanmail para provisionamento automático de usuário

  • Artigo

Este tutorial descreve as etapas a serem seguidas no Cleanmail e no Microsoft Entra ID para configurar o provisionamento automático de usuários. Quando configurado, o Microsoft Entra ID provisiona e cancela automaticamente o provisionamento de usuários e grupos para o Cleanmail 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 Cleanmail
  • Remover usuários do Cleanmail quando eles não precisarem mais de acesso
  • Manter os atributos do usuário sincronizados entre o Microsoft Entra ID e o Cleanmail
  • Logon único no Cleanmail (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 quais dados devem ser mapeados entre o Microsoft Entra ID e o Cleanmail.

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

Entre em contato com o suporte do Cleanmail para configurar o Cleanmail a fim de dar suporte ao provisionamento com o Microsoft Entra ID.

Adicione o Cleanmail por meio da galeria de aplicativos do Microsoft Entra para começar a gerenciar o provisionamento do Cleanmail. Se você já tiver configurado o Cleanmail para SSO, poderá usar o mesmo aplicativo. No entanto, recomenda-se criar um aplicativo diferente ao testar inicialmente a integração. 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 nos atributos do usuário e do 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.

  • Caso você precise de mais funções, atualize o manifesto do aplicativo para adicionar novas funções.

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

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 grupos no Cleanmail com base em atribuições de usuários e grupos no Microsoft Entra ID.

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

  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 Cleanmail.

    O link do Cleanmail 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 do Administrador, insira a URL do Locatário do Cleanmail como https://cloud.cleanmail.eu/api/v3/scim2 e o Token Secreto correspondente obtido da etapa 2. Clique em Testar Conectividade para verificar se o Microsoft Entra ID pode se conectar ao Cleanmail. Se a conexão falhar, verifique se a sua conta do Cleanmail 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 Cleanmail.

  10. Revise os atributos do usuário sincronizados do Microsoft Entra ID para o Cleanmail na seção Mapeamento de atributos. Os atributos selecionados como propriedades Correspondentes serão usados para fazer a correspondência entre as contas de usuário no Cleanmail para operações de atualização. Se você optar por alterar o atributo de destino correspondente, precisará verificar se a API do Cleanmail dá suporte à filtragem de usuários com base no atributo em questão. Selecione o botão Salvar para confirmar as alterações.

    Atributo Type Com suporte para filtragem Exigido pelo Cleanmail
    userName String ✓ ✓
    ativo Boolean ✓
    name.givenName String
    name.familyName String
    externalId 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 Cleanmail, altere o Status de Provisionamento para Ativado na seção Configurações.

    Status do provisionamento ativado

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

    Escopo de provisionamento

  14. Quando você 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 concluído do que os próximos ciclos, 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 quanto falta para a conclusão
  • 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