Guia de configuração personalizada do SAML SCIM via Entra ID

Um aplicativo SAML personalizado criado no Microsoft Entra ID, anteriormente chamado Azure, oferece provisionamento automático limitado, incluindo criação e remoção de usuários.

O que você vai precisar

  • Antes de configurar o provisionamento, é necessário ter o SAML personalizado ativado para o seu espaço de trabalho.
  • Somente administradores do Entra ID podem configurar o SCIM do Entra ID.

Configurar o aplicativo SAML personalizado do Microsoft Entra ID

Para configurar o aplicativo SAML personalizado:

  1. Crie um novo aplicativo SAML personalizado no Microsoft Entra ID.

    Este não é o aplicativo oficial ClickUp Microsoft Entra ID Gallery da ClickUp Productivity Platform.

    Captura de tela de alguém configurando um novo aplicativo SAML personalizado no Microsoft Entra ID.

  2. No ClickUp, no canto superior esquerdo, clique no avatar do seu Espaço de trabalho. 
  3. Selecione Configurações.
  4. Na barra lateral de todas as configurações, clique em Segurança & Permissões.
  5. Na seção Single sign-on (SSO), selecione SAML.
    Captura de tela da opção SAML nas configurações de Segurança e Permissões do ClickUp.
  6. Para um novo aplicativo Microsoft Entra ID, copie o SP Entity ID do ClickUp.
    Captura de tela do ID da entidade SP do ClickUp.
  7. Cole o ID da entidade SP do ClickUp no campo Identificador (ID da entidade) no Microsoft Entra ID.
    Captura de tela de alguém colando o ID da Entidade SP no campo Identificador.
  8. Copie o URL de logon único (URL do ACS) do ClickUp e cole-o no campo URL de resposta (URL do Assertion Consumer Service) no Microsoft Entra ID.
  9. Clique em Salvar no Microsoft Entra ID.
    Captura de tela do botão salvar no Microsoft Entra.

Link SSO no ClickUp

Agora que o aplicativo está configurado, você pode concluir a conexão SSO no ClickUp:

  1. Certifique-se de que a pessoa configurando a integração SSO seja designada no aplicativo Microsoft Entra ID. Outros podem ser adicionados posteriormente.
  2. Copie a URL de Login e o Certificado Público IDP do Microsoft Entra ID.
    Captura de tela do URL de login e do certificado público do IDP no Microsoft Entra ID.
  3. Cole esses valores em texto sem formatação nos campos vazios correspondentes do ClickUp ao selecionar o conector SAML.
    • Para obter o certificado em texto simples, faça o download e clique com o botão direito do mouse no arquivo para abri-lo em um editor de texto de sua escolha. O texto começa com -----BEGIN CERTIFICATE-----. Cole o valor de texto completo sem qualquer edição no campo Certificado Público IDP.
      Captura de tela de um certificado. 
  4. Selecione Salvar metadados.
    Captura de tela do botão Salvar metadados.
  5. Você será solicitado a completar o link fazendo login com logon único (SSO). Se bem-sucedido, você será redirecionado para o ClickUp.
  6. Na página Segurança & Permissões no ClickUp, você verá três novas opções:
    • URL da base SCIM: Você digitará essas informações na próxima etapa. 
    • Token da API SCIM: Você digitará essas informações na próxima etapa. 
    • Política de login: Escolha uma destas quatro opções:
      • Todos os usuários devem usar autenticação SAML: Todos os usuários do tipo membro e convidado devem usar autenticação SAML.
      • Todos os usuários, exceto Convidados, devem usar autenticação SAML: Usuários do tipo convidado não são obrigados a usar autenticação SAML. 
      • Todos os usuários, exceto Membros Limitados e Convidados, devem usar autenticação SAML: Membros limitados, membros limitados somente leitura e todos os usuários do tipo convidado não são obrigados a usar autenticação SAML. 
      • O uso da autenticação SAML é opcional: O uso da autenticação SAML é opcional para todos os usuários. 
  7. Vá para a próxima etapa para provisionar as outras pessoas em seu espaço de trabalho. 

Configure o provisionamento automático com o ClickUp

Oferecemos suporte ao provisionamento de usuários individuais e grupos com o SCIM. Ao provisionar grupos para o ClickUp, os novos usuários são provisionados como indivíduos, e os usuários novos e existentes são adicionados a uma equipe do ClickUp. Se você não quiser que esses usuários sejam adicionados a uma equipe, exclua a equipe após o provisionamento.

Ao adicionar um perfil de usuário ao aplicativo SAML personalizado, ele não é um usuário do ClickUp até que você o provisione via SCIM.

O provisionamento automático pode ser feito sob demanda ou em ciclos, que são executados em 30 minutos por padrão. Os usuários atribuídos ao aplicativo só serão adicionados quando o próximo ciclo de provisionamento automático for executado. Saiba mais sobre como funciona o provisionamento de aplicativos no Microsoft Entra ID

Captura de tela do botão de provisionamento sob demanda.

Para configurar o provisionamento automático:

  1. No Microsoft Entra ID, abra a guia Provisionamento e altere a lista suspensa de Manual para Automático. Isso fará com que a janela Credenciais do administrador seja exibida na guia Provisionamento.
    • Se você quiser provisionar manualmente até cinco usuários de cada vez, na guia Provisionamento, selecione Provisionamento sob demanda.
      Captura de tela da janela de credenciais de administrador na guia Provisionamento.
  2. Insira o URL básico do SCIM da página ClickUp Security & Permissions no campo Tenant URL (URL do locatário ).
  3. Insira o Token da API SCIM da sua página de Segurança & Permissões do ClickUp no campo Token Secreto.
  4. Clique em Testar conexão.
    Captura de tela do botão de teste de conexão.
  5. Quando o teste for bem-sucedido, o SCIM estará configurado em seu espaço de trabalho. Os usuários podem entrar no ClickUp usando o Microsoft Entra ID.

Selecione as funções de usuário do ClickUp que você deseja provisionar

O padrão da função de usuário é membro, a menos que você selecione as funções de usuário do ClickUp que deseja provisionar. 

Para mapear o Microsoft Entra ID para as funções de usuário do ClickUp:

  1. Como administrador, faça login no centro de administração do Microsoft Entra. 
  2. Selecione Identidade, Aplicativos e, em seguida, Enterprise aplicativos.
  3. Na página de aplicativos Enterprise, selecione seu aplicativo SAML.
  4. Na página Overview (Visão geral), na barra lateral esquerda, selecione Provisioning (Provisionamento).
  5. Na página Provisionamento, clique em Mapeamentos.
  6. Selecione Provisionar usuários do Microsoft Entra ID para ver uma lista de atributos.
  7. Role até a parte inferior da página e clique na caixa de seleção Mostrar opções avançadas.
  8. Clique em Editar lista de atributos.
    Captura de tela de alguém selecionando Mostrar opções avançadas e Editar lista de atributos
  9. Role até a última linha da coluna Nome e insira este atributo urn para funções de usuário: urn:ietf:params:scim:schemas:extension:ClickUp:2.0:User:role.
  10. No menu suspenso da coluna Type (Tipo), verifique se String está selecionado. 
  11. No canto superior esquerdo, clique em Salvar
    • Se o nome não for salvo, selecione Descartar e tente novamente. Se você continuar a ver o nome não ser salvo, tente redefinir seus mapeamentos para os padrões.
  12. Você será redirecionado para a página Attribute Mapping (Mapeamento de atributos ).
  13. Selecione Add New Mapping (Adicionar novo mapeamento).
  14. Na página Edit Attribute (Editar atributo ), para o tipo de mapeamento, selecione Constant (Constante).
    • Para mapear dinamicamente, consulte a seção Fornecer dinamicamente funções de usuário abaixo.
  15. Em Constant Value, digite um dos seguintes valores:
    • para administradores.
    • 3 para membros.
    • 4 para convidados. 
    • 100 para membros limitados.
    • {custom_role_id} para funções personalizadas.
  16. Para o atributo Target, digite urn:ietf:params:scim:schemas:extension:ClickUp:2.0:User:role.
  17. Clique em OK e em Salvar.
  18. Qualquer usuário que você provisionar será provisionado como essa função de usuário do ClickUp.  
    • Para mapear outra função de usuário, comece na etapa 5 e selecione um Constant Value diferente. Para mapear dinamicamente, consulte a seção Fornecer dinamicamente funções de usuário abaixo.

Os seguintes atributos de função de usuário também podem ser mapeados:

Modelo Atributos da função do usuário
Base

ID

Nome de usuário

Nome: {givenName and familyName}

ativo

E-mail

Matriz de e-mails com propriedade de valor e propriedade primária (booleana)

Título

Gerente

Extensão

Função

customRoleId: Digite o ID da função personalizada do ClickUp.

Para encontrar o ID da função personalizada, envie a solicitação Get User (Obter usuário ) da API do ClickUp. Esse ponto de extremidade está disponível apenas nos planos Enterprise.

customRoleName: Digite o nome da função personalizada do ClickUp.

Enterprise Gerente

Fornecer dinamicamente funções de usuário

Gerencie dinamicamente as funções de usuário no ClickUp com base nas funções de usuário atribuíveis no Entra. Isso será feito compartilhando dinamicamente os valores de função com o atributo de destino. O resultado permitirá que você atribua funções no Entra que mapeiam as funções do ClickUp, tornando o provisionamento mais simples.

Para ajustar o mapeamento do atributo de destino de constante para uma expressão para provisionar dinamicamente as funções de usuário:

  1. Na página Overview (Visão geral), na barra lateral esquerda, selecione Provisioning (Provisionamento).
  2. Na página Provisionamento, clique em Mapeamentos e, em seguida, em Provisionar usuários do Microsoft Entra ID.
    • Se você ainda não o fez, role até a última linha da coluna Nome e insira este atributo urn para funções de usuário: urn:ietf:params:scim:schemas:extension:ClickUp:2.0:User:role.
  3. Selecione Editar à direita do atributo da urna.
  4. Escolha o tipo de mapeamento de expressão e adicione essa expressão: Switch(SingleAppRoleAssignment([appRoleAssignments]), " 3 ", "ClickUpAdmin", "2 ", "ClickUpGuest", "4 ", "ClickUpLimitedMember", "100").
    • Nessa expressão, 3 é o valor padrão, seguido pelos pares de chave e valor correspondentes para a função Entra / função ClickUp. Saiba mais sobre como escrever expressões para mapeamentos de atributos no Microsoft Entra ID
    • Você pode dar o nome que quiser a essas funções do Entra ao criá-las na seção Registro de aplicativos. Desde que o argumento a seguir mapeie o valor correto da função de usuário do ClickUp e você selecione essas funções do Entra ao atribuir usuários ao ClickUp, eles serão provisionados corretamente.
    • Você pode escolher outras expressões lógicas, se preferir, desde que o atributo ClickUp urn receba um número válido que mapeie uma função de usuário.
  5. Clique em Salvar.
  6. Agora, ao atribuir usuários ou grupos em Usuários e grupos, selecione a função correspondente que você gostaria que o usuário tivesse no ClickUp.
  7. Quando você provisionar esse usuário, ele receberá a função correta.

    Se um usuário for provisionado como um único usuário e também em um grupo, certifique-se de que o usuário não seja atribuído a duas funções de aplicativo diferentes, pois isso causará erros.