Configure a autenticação JSON Web Token (JWT) para permitir que os leitores façam login de forma segura usando tokens do seu aplicativo ou provedor de identidade. Este artigo aborda as duas etapas de configuração que você completa dentro do Document360 antes de conectar sua aplicação.
Somente usuários com as funções de projeto Proprietário ou Administrador podem configurar o JWT no Document360.
Antes de começar
Para acessar a página do JWT, navegue até Configurações () > Usuários e permissões > JWT.
.png)
Novidade no JWT no Document360
Se não houver nenhuma configuração de JWT no seu projeto, complete os seguintes passos em ordem:
- Configurar login no JWT: configurar configurações compartilhadas em nível de projeto.
- Crie uma configuração de JWT: adicione sua primeira configuração de JWT.
- Configure sua aplicação: conecte-a ao Document360.
Configurações adicionais de JWT e provedores SSO (SAML ou OpenID) podem ser adicionados ao mesmo projeto a qualquer momento sem afetar configurações existentes.
Configuração existente do JWT
Se você configurou o JWT antes de junho de 2026, sua configuração atual aparece em uma visualização somente leitura. Sua configuração atual do JWT permanece ativa, e os leitores podem continuar fazendo login sem interrupções.
Quando você navega até Configurações () > Usuários e permissões > JWT, você pode:
- Continue usando a configuração: não são necessárias alterações.
- Editar a configuração: clique no ícone Editar para atualizar as configurações.
- Exclua a configuração: clique no ícone Excluir para removê-la.
Para adicionar outra configuração de JWT, clique em Criar JWT e siga os Passos 1 e 2 abaixo. Um projeto pode ter até 5 configurações de JWT. Após salvar, a página muda para a visualização de lista e exibe todas as entradas configuradas do JWT. Sua configuração atual permanece inalterada.
Para configurar SSO junto com o JWT, acesse Configurações () > Usuários e permissões > Configuração de SSO e configure seu provedor SSO. Sua configuração do JWT não é afetada. Ambos estarão ativos ao mesmo tempo e os leitores verão ambas as opções na página de login. Veja Gerenciando configurações do JWT para detalhes sobre como é a página de login.
Passo 1: Configurar login no JWT
Clique em Configurar login JWT no banner da página do JWT para abrir o modal de configuração.
O modo de login Configure JWT também permite reordenar o botão de login JWT no seu site de base de conhecimento. Clique em Abrir construtor de site para reordenar os botões de login diretamente na personalização do site. Para saber mais, leia os limites dos botões de login.
Autenticação
Esses são valores somente leitura gerados pelo Document360. Copie usando o botão Copiar e configure-os no seu provedor de identidade.
| Campo | Descrição |
|---|---|
| URL de retorno de chamada | A URL de redirecionamento onde o provedor de identidade envia leitores após a autenticação bem-sucedida. Registre isso no seu IDP para completar o processo de login. |
| URL de geração de código | O endpoint Document360 chama para recuperar o token usado para iniciar sessão nos leitores. |
Outros cenários
Login direto do JWT
Padrão: LIGADO
- Quando ativados, os leitores são redirecionados diretamente para o login do JWT sem que apareça uma tela de seleção de login. Isso é apropriado quando o JWT é o único método de autenticação para sua base de conhecimento.
- Quando desativado, os leitores recebem uma tela de seleção de login mostrando todas as opções de login configuradas (JWT, SSO e o login padrão do Document360). Desative essa configuração quando múltiplos métodos de autenticação estiverem ativos e os leitores precisarem escolher seu método de login. É necessária uma confirmação antes que essa mudança seja aplicada.
- Quando múltiplas configurações de JWT e SSO estão configuradas, mas o dono do projeto quer que os leitores entrem apenas via autenticação JWT, eles podem ativar o login direto do JWT.
Desabilitar a página padrão de login
Padrão: DESLIGADO
- Quando ativado, o login padrão de e-mail e senha do Document360 fica oculto. Leitores só podem se autenticar por meio de provedores JWT ou SSO configurados. Isso é tipicamente usado em ambientes empresariais, onde todo acesso dos leitores deve ser controlado por meio de um sistema centralizado de identidade.
Ative essa configuração somente após a autenticação JWT ou SSO estar totalmente configurada e testada. Se o provedor externo de autenticação estiver configurado incorretamente, os leitores não poderão acessar a base de conhecimento.
Clique em Fechar para descartar o modal. As mudanças são aplicadas imediatamente.
Passo 2: Criar uma configuração JWT
Na página do JWT, clique em Criar JWT no canto superior direito. O modal Create JWT abre.
Nome
Insira um nome descritivo para identificar essa configuração, por exemplo, "SSO do Portal do Cliente". Esse nome aparece na lista JWT no portal. Se o botão de login estiver ativado, esse nome também é exibido aos leitores na página de login, então deve ser significativo para o público que está fazendo login.
Campos de autenticação
| Campo | Obrigatório | Descrição |
|---|---|---|
| ID do cliente | Sim | Gerado automaticamente pelo Document360. Este é o identificador único para essa configuração JWT. Copie usando o ícone de copiar e adicione ao seu aplicativo cliente. |
| Login URL | Sim | A URL no seu aplicativo onde os leitores são enviados para autenticar (por exemplo, https://app.example.com/login). |
| Nome de domínio | Sim | Derivado automaticamente a partir da URL de login. Este é o domínio associado a essa configuração do JWT. Quando um leitor entra nesse domínio na página de login, ele é direcionado para a URL de login dessa configuração. O domínio deve ser único em todas as configurações JWT do projeto. |
| Logout URL | Não | A URL para a qual os leitores são redirecionados após sair (por exemplo, https://app.example.com/logout). Se não especificado, os leitores são direcionados para a página padrão de logout do JWT no Document360. |
Regras de validação de nomes de domínio:
- Subdomínios são tratados como entradas distintas.
portal.example.comeexample.comsão domínios separados e podem ser atribuídos a diferentes configurações. - Domínios curinga como
*.example.comnão são suportados. Cada domínio deve ter um valor exato. - Um domínio já atribuído a outra configuração JWT no mesmo projeto não pode ser reutilizado. Um erro de validação em linha é mostrado no save.
Chaves JWT
Fichas secretas são exibidas apenas uma vez no momento da criação. Copie e armazene com segurança antes de fechar o modal. Se forem perdidos, eles devem ser regenerados, o que invalida imediatamente os tokens anteriores.
O Document360 gera automaticamente dois tokens secretos quando o modal é aberto. Esses tokens são visíveis apenas em texto simples durante esta sessão. Uma vez que o modal é fechado, eles são mascarados e não podem ser recuperados.
| Token | Propósito |
|---|---|
| Token secreto primário | Assina e verifica as solicitações de autenticação do JWT entre sua aplicação e o Document360. Esse token deve ser mantido em sigilo. Se for comprometido, regenere imediatamente e atualize seu aplicativo para evitar acessos não autorizados. |
| Token secreto secundário | Serve como chave de assinatura reserva para apoiar a rotação de credenciais sem interrupção do serviço. Durante a rotação, o token secundário permite que a autenticação continue enquanto o token primário está sendo atualizado. |
Use o ícone Copiar ao lado de cada token para copiar seu valor.
Configurações avançadas
Expanda as configurações avançadas para configurar as seguintes opções.
Ativar a autenticação JWT
Padrão: LIGADO
Quando ativada, essa configuração está ativa e os leitores podem usá-la para fazer login. Desabilitá-lo desativa a configuração sem deletá-la, o que é útil para suspender temporariamente uma configuração sem perder suas configurações.
Mostrar botão de login
Padrão: DESLIGADO
Quando ativado, um botão de login com marca para essa configuração aparece na página de login da base de conhecimento. Isso oferece aos leitores uma opção de login direto sem precisar inserir um nome de domínio.
No máximo, 3 botões de login do JWT podem ser exibidos simultaneamente na página de login. Quando esse limite é atingido, o botão de alternância é automaticamente desativado para configurações adicionais. Leitores designados a configurações sem um botão visível ainda podem se autenticar digitando seu nome de domínio no campo Nome de domínio na página de login. Para controlar a ordem em que os botões JWT e SSO aparecem na página de login, veja Gerenciando configurações JWT.
Quando o botão Mostrar login está ativado, os seguintes campos adicionais estão disponíveis:
- Texto do botão de login: a etiqueta exibida no botão. Isso deve identificar claramente a fonte de autenticação para os leitores.
- Logo do botão de login: uma imagem enviada para marcar o botão. Formatos aceitos: JPG, PNG, SVG. Tamanho máximo do arquivo: 512 KB.
Passo 3: Configure sua aplicação
Copie os seguintes valores da configuração do JWT e adicione-os aos campos correspondentes do seu aplicativo cliente:
- ID do cliente
- URL de retorno de chamada
- URL de geração de código
- Token secreto primário
- Token secreto secundário
Clique em Criar. O botão permanece inativo até que todos os campos necessários contenham valores válidos. Em caso de sucesso, o modal fecha e a nova configuração aparece na lista JWT.
Leitores não precisam de uma conta separada no Document360. A autenticação é feita inteiramente pelo seu aplicativo. Uma conta no seu aplicativo é suficiente para que um leitor acesse a base de conhecimento.
Depois de salvar a configuração, proceda a Implementar JWT na sua aplicação para configurar a lógica de redirecionamento do backend.
Para habilitar ou desativar uma configuração, regenerar tokens secretos, gerenciar o roteamento de domínios ou revisar logs de auditoria após o lançamento, veja Gerenciando configurações JWT.