Jamdesk Documentation logo

Single Sign-On (SSO)

Entre no painel do Jamdesk com seu provedor de identidade. Configure SAML ou OIDC em qualquer plano pago; o SSO para leitores do site de docs é Enterprise.

O Jamdesk tem dois tipos de Single Sign-On. O SSO do painel faz login da sua equipe no painel por meio do seu provedor de identidade. Você mesmo o configura em Configurações, em qualquer plano pago. O SSO do site de documentação faz login dos leitores da sua documentação publicada pelo seu IdP, em vez de uma senha compartilhada. Nossa equipe configura esse recurso nos planos Enterprise.

Para acesso individual à documentação sem um plano Enterprise, use autenticação JWT. Se o seu produto tem login próprio, o seu backend autentica os leitores. Está disponível em todos os planos.

O que o SSO abrange

SSO do painel

Sua equipe faz login em dashboard.jamdesk.com com o seu provedor de identidade. Você tem contas centralizadas, MFA obrigatório pelo seu IdP e desprovisionamento imediato. Configure em Configurações → Single Sign-On.

SSO do site de documentação

Os leitores se autenticam no seu IdP para ver a documentação protegida. Você tem login individual por usuário, trilha de auditoria e desprovisionamento na remoção, em vez de uma senha compartilhada. Nossa equipe configura esse recurso nos planos Enterprise.

Para quem é

O SSO exige um provedor de identidade: Okta, Google Workspace, Microsoft Entra ID, Auth0 ou qualquer provedor SAML 2.0 / OIDC.

O SSO do painel oferece controle centralizado sobre quem gerencia os projetos. O MFA é aplicado pelo seu IdP. Com o SSO obrigatório, remover alguém do seu diretório bloqueia o login dessa pessoa no painel.

O SSO do site de documentação oferece uma trilha de auditoria de quem leu quais documentos. Ele substitui uma senha compartilhada por acesso individual por usuário.

Ativar o SSO do dashboard

O SSO do painel é de autoatendimento em qualquer plano pago. Verifique o domínio do seu e-mail, conecte o seu provedor de identidade e, opcionalmente, exija SSO para todos no domínio.

Antes de começar

  • Um plano pago do Jamdesk.
  • Acesso de proprietário ao projeto. A conexão SSO cobre todos os projetos que você possui. Somente o proprietário vê as configurações de Single Sign-On.
  • Acesso ao DNS do seu domínio para adicionar um registro TXT.
  • Acesso de administrador ao seu provedor de identidade (Okta, Microsoft Entra, Google Workspace, Auth0 ou qualquer provedor SAML 2.0 / OIDC).

Configurar a conexão

1
Abrir as configurações de Single Sign-On

No painel, acesse Configurações → Single Sign-On e informe o domínio de e-mail da sua empresa, por exemplo acme.com. O Jamdesk cria uma conexão e mostra um registro TXT de DNS para verificação do domínio.

2
Verificar seu domínio

Adicione um registro TXT com o nome e o valor exibidos no painel ao DNS do seu domínio. Clique em Verificar. As alterações de DNS podem levar até uma hora para se propagar. Se a primeira tentativa falhar, aguarde e tente novamente. Mantenha o registro após a verificação. O Jamdesk o verifica periodicamente e desativa a conexão se ele for removido.

3
Configurar seu provedor de identidade

Copie o Entity ID e a ACS URL do painel para um novo aplicativo SAML ou OIDC no seu IdP. Cole os dados do seu IdP de volta no Jamdesk:

  • SAML 2.0: Entity ID do IdP, URL de SSO e o certificado de assinatura X.509 em formato PEM.
  • OIDC: URL do emissor, ID do cliente e segredo do cliente.

Escolha seu provedor na lista para um guia de configuração específico. Clique em Salvar e ativar. A conexão passa para Ativa.

4
Exigir SSO (opcional)

Com a conexão Ativa, ative Exigir SSO para todos os usuários do seu domínio. Todo e-mail desse domínio passará a fazer login pelo seu IdP. O login por senha e pelo Google deixa de funcionar para eles. Sua conta de proprietário continua isenta. Adicione até 20 e-mails de emergência para administradores que precisem de uma senha alternativa caso o seu IdP fique indisponível.

Adicione pelo menos um e-mail de emergência antes de ativar a obrigatoriedade. Sem ele, uma queda do IdP bloqueia todos no domínio do acesso ao painel.

Como os usuários entram

O login SSO do painel é primeiro o e-mail. Digite um e-mail corporativo na tela de login. Se o domínio tiver uma conexão SSO, o Jamdesk redireciona para o seu provedor de identidade. Não existe um botão separado de "Entrar com SSO".

Entrar pelo seu IdP não concede acesso. Cada membro da equipe ainda precisa de um convite para um projeto. Sem ele, verá "Sua conta não está provisionada". Um login bloqueado leva a uma página de erro de SSO que explica o próximo passo.

Solução de problemas

As alterações de DNS podem levar até uma hora para chegar ao Jamdesk. Aguarde e clique em Verificar novamente. Se continuar falhando, confira se o nome e o valor do registro correspondem exatamente ao painel. Alguns provedores de DNS acrescentam o seu domínio ao nome do registro, transformando _jamdesk em _jamdesk.acme.com.acme.com. Remova o sufixo duplicado.

O Jamdesk verifica novamente o registro TXT do seu domínio após a configuração. Um registro removido ou alterado move a conexão para Desativada. Os logins deixam de ser direcionados ao seu IdP. Adicione o registro de volta ao DNS e clique em Verificar status novamente, ou exclua a conexão e comece de novo.

Ele se autenticou no seu provedor de identidade, mas nunca foi convidado para um projeto. Convide-o em Configurações → Membros. Depois, peça para ele fazer login novamente. Veja Membros da equipe.

A obrigatoriedade está ativa. A pessoa tentou entrar com senha ou Google em vez do seu IdP. Peça para usar o fluxo que começa pelo e-mail, que redireciona para o seu provedor. Para uma senha alternativa (por exemplo, se o seu IdP estiver fora do ar), adicione o endereço à lista de emergência.

Ativar o SSO do site de docs

Nossa equipe configura o SSO de leitores do site de documentação. Verificamos seus metadados, mapeamentos de claims e filtros de grupo antes de restringir sua documentação publicada.

Fale com o time de vendas Enterprise →

A página de preços lista os planos e o caminho de contato Enterprise. Nossa equipe configura o IdP com você, testa em um subdomínio de homologação e faz o lançamento em produção quando você estiver pronto.

Alternativas

Proteja sua documentação sem o Enterprise:

Proteção por senha

Restrição por senha compartilhada para todo o site ou para páginas específicas. Disponível sem um plano Enterprise.

Visão geral do controle de acesso

Compare lado a lado as quatro opções de acesso.