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

Este tutorial descreve as etapas que você precisa executar no Colloquial e no Microsoft Entra ID para configurar o provisionamento automático de usuários. Quando configurado, o Microsoft Entra ID provisiona e desprovisiona automaticamente os usuários para Colloquial utilizando 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 Colloquial.
• Remova usuários no Colloquial quando eles não exigirem mais acesso.
• Mantenha os atributos do usuário sincronizados entre o Microsoft Entra ID e o Colloquial.
• Logon único no Colloquial (recomendado).

Pré-requisitos

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

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

Etapa 1: Planeje a implantação do provisionamento

• Saiba mais sobre como funciona o serviço de provisionamento.
• Determine quem estará no escopo de provisionamento.
• Determine quais dados devem ser mapeados entre o Microsoft Entra ID e o Colloquial.

Etapa 2: configurar o Colloquial para dar suporte ao provisionamento com o Microsoft Entra ID

Entre em contato com o suporte do Colloquial para configurar o Colloquial para dar suporte ao provisionamento com o Microsoft Entra ID.

Etapa 3: adicionar o Colloquial da galeria de aplicativos do Microsoft Entra

Adicione o Colloquial a partir da galeria de aplicativos do Microsoft Entra para começar a gerenciar o provisionamento para o Colloquial. Se você tiver configurado previamente o Colloquial para SSO, poderá utilizar o mesmo aplicativo. No entanto, recomendamos que criar 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 quem estará no escopo de provisionamento com base na atribuição ao aplicativo e/ou nos atributos do usuário. 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 ao aplicativo. Se você optar por definir quem estará no escopo de provisionamento com base somente em atributos do usuário, poderá usar um filtro de escopo, conforme descrito aqui.

• Comece pequeno. Faça o teste com um pequeno conjunto de usuários antes de implementar para todos. Quando o escopo de provisionamento é definido para usuários atribuídos, é possível controlar isso atribuindo um ou dois usuários ao aplicativo. Quando o escopo é definido para todos os usuários, é 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 Colloquial

Esta seção guiará você pelas etapas para configurar o serviço de provisionamento do Microsoft Entra para criar, atualizar e desabilitar usuários no Colloquial com base nas atribuições de usuários no Microsoft Entra ID.

Para configurar o provisionamento automático de usuários para o Colloquial 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

   

3. Na lista de aplicativos, selecione Colloquial.

   

4. Selecione a guia Provisionamento.

   

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

   

6. Na seção Credenciais de Administrador, insira a URL do locatário do Colloquial e o Token Secreto. Clique em Testar conexão para garantir que o Microsoft Entra ID possa se conectar ao Colloquial. Se a conexão falhar, certifique-se de que sua conta do Colloquial tenha permissões de administrador e tente novamente.

   

7. No campo Notificação por Email, insira o endereço de email de quem 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.

   

8. Selecione Salvar.

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

10. Faça a revisão dos atributos do usuário que são sincronizados do Microsoft Entra ID para o Colloquial na seção Mapeamento do Atributo. Os atributos selecionados como propriedades Correspondentes são utilizados para corresponder às contas de usuário no Colloquial para operações de atualização. Se optar por alterar o atributo destino correspondente, é necessário garantir que a API Colloquial dê suporte à filtragem de usuários com base nesse atributo. Selecione o botão Salvar para confirmar as alterações.

    Atributo	Type	Com suporte para filtragem	Exigido pelo Colloquial
    userName	String	✓	✓
    ativo	Boolean		✓
    emails[type eq "work"].value	String		✓
    preferredLanguage	String
    name.givenName	String		✓
    name.familyName	String		✓
    externalId	String
    localidade	String
    timezone	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 para o Colloquial, altere o Status de Provisionamento para Ativado na seção Configurações.

    

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

    

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

    

Essa operação inicia o ciclo de sincronização inicial de todos os usuários definidos em 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 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

• Gerenciamento do provisionamento de conta de usuário para Aplicativos Empresariais
• O que é o acesso a aplicativos e logon único com o Microsoft Entra ID?

Próximas etapas

• Saiba como fazer revisão de logs e obter relatórios sobre atividade de provisionamento