Os grupos de leitores do JWT permitem que você controle quais seções da sua base de conhecimento privada cada leitor autenticado pode acessar. Quando um leitor faz login pelo JWT SSO, o Document360 usa os IDs dos grupos de leitores em seu payload token para determinar quais versões do projeto, idiomas, categorias e artigos ele pode visualizar.
Um grupo de leitores do JWT é idêntico a um grupo regular do Document360. Ela herda as mesmas configurações de restrição. A única diferença é como funciona a atribuição: em vez de atribuir os leitores manualmente no portal, você passa os IDs dos grupos diretamente no payload do JWT.
Quando usar grupos de leitores JWT
Use grupos de leitores do JWT quando precisar impor restrições de acesso baseadas em conteúdo para leitores que se autenticam pelo SSO do JWT.
Exemplo de cenário:
Sua equipe de vendas precisa de acesso a artigos de preços e faturamento, mas não deve ter acesso à documentação da API ou aos artigos técnicos principais.
Solução:
- Crie um grupo de leitores no projeto privado Document360, concedendo acesso apenas à categoria de preços.
- Designe os membros da equipe de vendas para esse grupo de leitores.
Outros cenários comuns incluem:
- Um nível de cliente que só pode acessar guias de integração, não conteúdo de configuração avançada.
- Múltiplos segmentos de usuários que precisam de diferentes visões da mesma base de conhecimento privada.
Se sua base de conhecimento for pública ou todos os leitores autenticados devem ver o mesmo conteúdo, não é obrigatória a atribuição em grupo de leitores.
Antes de começar
- Seu projeto deve ter o SSO do JWT configurado. Se você ainda não configurou, veja Configurar JWT no Document360.
- Pelo menos um grupo de leitores deve existir no seu projeto. Você pode criar e gerenciar grupos de leitores a partir de Configurações > Usuários e permissões > Leitores & grupos > aba Grupos de Leitores .
- Você deve ter um cargo de Proprietário do Projeto ou Administrador para acessar as configurações do grupo de leitores.
IDs de grupos de leitores estão disponíveis apenas para projetos configurados pelo JWT. Eles não são visíveis em projetos normais de base de conhecimento privada sem JWT.
Passo 1: Obtenha o ID do seu grupo de leitores
Cada grupo de leitores no Document360 tem um ID único que você inclui no payload do JWT para atribuir leitores a esse grupo.
- Vá para Configurações > Usuários e permissões > Leitores & grupos.
- Selecione a aba Grupos de Leitores .
- Encontre o grupo de leitores que você quer usar. O ID do grupo é exibido abaixo do nome do grupo.
- Clique no ícone Copiar para copiar o ID do Grupo na sua prancheta.
Passo 2: Adicionar IDs de grupos de leitores ao seu payload JWT
Depois de ter o ID de Grupo, inclua-o no readerGroupIds campo da sua carga útil do JWT.
Use o seguinte formato JSON:
{
"username": "firstname + lastname",
"firstName": "firstname",
"lastName": "lastname",
"emailId": "user emailId",
"readerGroupIds": [
"26b3812e-7879-4407-b1c9-5755c32b886a",
"674eadcd-793f-4131-b1e0-c1f055cc83b7"
],
"tokenValidity": 15
}
Para atribuir um leitor a múltiplos grupos, adicione cada ID de Grupo como uma entrada separada no array, separada por vírgulas.
Exemplo para múltiplos grupos:
"readerGroupIds": ["26b3812e-7879-4407-b1c9-5755c32b886a", "674eadcd-793f-4131-b1e0-c1f055cc83b7"]
O tokenValidity campo define quanto tempo o token permanece válido, em minutos. O valor mínimo é 5 minutos e o máximo é 1440 minutos (1 dia).
Quando o leitor autentica e acessa a base de conhecimento, as restrições definidas no grupo de leitores designado se aplicam automaticamente. Eles só podem visualizar as versões do projeto, idiomas, categorias e artigos permitidos por esse grupo.
Momento das mudanças
Alterações nos IDs dos grupos de leitores na carga útil (adições ou remoções) só entram em vigor após o término da sessão atual do leitor, com base no período de validade do token.
Exemplo: Se a validade do token for definida para 30 minutos e você adicionar um novo ID de Grupo ao payload, a mudança não se aplicará até que 30 minutos tenham se passado. O mesmo vale ao remover um ID de grupo.
Planeje qualquer mudança no grupo de leitores levando esse atraso em mente, especialmente se você precisar que as mudanças de acesso entrem em vigor imediatamente para um leitor específico.
Melhores práticas
- Mantenha a validade do token o mais curta possível possível para o seu caso de uso. Validade menor significa que as mudanças de acesso entram em vigor mais cedo.
- Audite regularmente as tarefas em grupo dos leitores para garantir que eles não estejam mantendo acesso a conteúdos que não precisam mais.
- Use o ícone de cópia no portal para colar diretamente os IDs de grupo, evitando erros manuais de transcrição.
- Atribuição de grupo de leitores de teste após qualquer alteração de carga útil, fazendo login como conta de leitor de teste para confirmar que as restrições de acesso são aplicadas conforme esperado.
FAQ
Um leitor pode pertencer a mais de um grupo de leitores?
Sim. Você pode incluir múltiplos IDs de Grupo no readerGroupIds array. O leitor herdará as permissões combinadas de acesso de todos os grupos designados.
Por que não consigo ver o ID do Grupo no meu projeto?
IDs de grupos de leitores só são visíveis em projetos configurados pelo JWT. Se seu projeto não tiver JWT SSO ativado, o campo ID de Grupo não aparecerá na aba Grupos de Leitores.
O que acontece se eu adicionar um ID de Grupo inválido ao payload?
O token ainda será gerado, mas o ID de Grupo inválido não será mapeado para nenhum grupo. O leitor pode não ter as restrições de acesso esperadas aplicadas. Sempre verifique os IDs de grupo copiando-os diretamente do portal.
Se eu remover um ID de grupo do payload, o leitor perde o acesso imediatamente?
Não. As mudanças só entram em vigor após o vencimento do token atual. Se a validade do token for definida para 30 minutos, mudanças de acesso serão aplicadas após 30 minutos a partir da última emissão do token.