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 etapas de configuração que você completa dentro do Document360 antes de conectar seu aplicativo.
Somente usuários com as funções de projeto Proprietário ou Administrador podem configurar o JWT no Document360.
Antes de começar
Esse é o caminho para acessar as configurações Configurações () > Usuários e permissões > SSO Empresarial > Criar SSO > JWT.
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 outubro de 2026, sua configuração atual agora aparece junto com quaisquer outras configurações de SSO na mesma página de SSO Empresarial em Configurações () > Usuários e permissões > SSO Empresarial. Sua configuração atual no JWT permanece ativa, e os leitores podem continuar fazendo login sem interrupções.
Da lista de configuração do SSO, 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 SSO, selecione JWT e siga os Passos 1 e 2 abaixo. Um projeto pode ter até 5 configurações de JWT. Sua configuração atual permanece inalterada.
Para configurar SSO junto com o JWT, clique em Criar SSO a partir da mesma lista e escolha SAML ou OpenID Connect. 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 é apresentada.
Passo 1: Configurar login no JWT
Clique no botão Configurações no canto superior direito da página do SSO Empresarial para abrir o diálogo de Configurações de Login . Esta é uma configuração única em nível de projeto que se aplica a todas as opções de login, não algo que você configura conforme a configuração do JWT.
Para alterar a ordem em que o botão de login do JWT aparece junto com outras opções de login no seu site de base de conhecimento, use o botão de arrastar e soltar ou reordenar o teclado diretamente na lista de configuração do SSO. Para saber mais, leia as opções de login de reordenação.
Login direto do JWT
Padrão: LIGADO
- Quando ativado, os leitores são redirecionados diretamente para o login do JWT sem que seja exibida 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 o 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 encerrar o diálogo. As alterações são aplicadas imediatamente.
Passo 2: Criar uma configuração JWT
Na lista de configuração de SSO, clique em Criar SSO e selecione JWT. O modal Criar SSO - JWT abre com duas abas: Autenticação e Configurações do Servidor.
Aba de autenticação
Nome
Insira um nome descritivo para identificar essa configuração, por exemplo, "Portal do Cliente SSO". Esse nome aparece na lista de configuração do SSO. 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.
Autenticação
Esses são valores somente leitura gerados pelo Document360. Copie-os usando o botão Copiar e configure-os no seu provedor de identidade ou aplicativo cliente.
| Campo | Descrição |
|---|---|
| URL de retorno de chamada | A URL de redirecionamento onde o provedor de identidade envia leitores após 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. |
| ID do cliente | Gerado automaticamente pelo Document360. Este é o identificador único para essa configuração JWT. Copie e adicione ao seu aplicativo cliente. |
Chaves JWT
Tokens secretos são exibidos apenas uma vez no momento da criação. Copie e armazene com segurança antes de fechar o modal. Se 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 essa 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 os pedidos de autenticação do JWT entre sua aplicação e o Document360. Este token deve ser mantido confidencial. Se comprometido, regenere-o imediatamente e atualize sua aplicação para evitar acessos não autorizados. |
| Token secreto secundário | Serve como chave de assinatura reserva para suportar 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 principal está sendo atualizado. |
Use o ícone Copiar ao lado de cada campo e token para copiar seu valor. Clique em Próximo para continuar na aba de configurações do servidor .
Aba de configurações do servidor
| Campo | Obrigatório | Descrição |
|---|---|---|
| Login URL | Sim | A URL no seu aplicativo onde os leitores são enviados para autenticar (por exemplo, https://app.example.com/login). |
| Logout URL | Não | A URL para a qual os leitores são redirecionados após a saída da sessão (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 do Document360. |
| Nome de domínio | — | Derivado automaticamente a partir da URL de login. Este é o domínio associado a esta configuração 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. |
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.
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 fica ativa e os leitores podem usá-la para fazer login. Desativá-la desativa a configuração sem excluí-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 para configurações sem um botão visível ainda podem 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 Opções de login Reordenando.
Quando o botão Mostrar login está ativado, os seguintes campos adicionais estão disponíveis:
- Texto do botão de login: o rótulo exibido no botão. Isso deve identificar claramente a fonte de autenticação para os leitores.
- Logotipo do botão de login: uma imagem carregada para marcar o botão. Formatos aceitos: JPG, PNG, SVG. Tamanho máximo do arquivo: 512 KB.
Clique em Criar para salvar a configuração.
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 de configuração SSO.
Leitores não precisam de uma conta Document360 separada. 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.