Choosing a handshake

Esta é a documentação para os métodos deAutenticaçãoHandshake. A personalização oferece umconjunto diferente de métodos de Handshake.

Antes que seus usuários possam acessar conteúdo personalizado, eles devem ser autenticados. O Mintlify suporta quatro métodos de Handshake de Autenticação:

1. Senha: Configure um conjunto de senhas globais para o seu site de documentação.
2. JWT: Use seu próprio fluxo de login para autenticar seus usuários via JWT na URL.
3. OAuth 2.0: Integre com seu servidor OAuth para permitir o login do usuário através do fluxo padrão de Código de Autorização.
4. Dashboard do Mintlify: Permita que todos os usuários do seu dashboard acessem sua documentação, sem necessidade de configuração.

Pré-requisitos

Senha

• Seus requisitos de segurança permitem o compartilhamento de senha entre os leitores da documentação.

• Seus requisitos de segurança permitem o compartilhamento de senha entre os leitores da documentação.

• Você tem algum fluxo de login existente.
• Você pode adicionar uma etapa final neste fluxo de login que cria um JWT e redireciona para a documentação.

• Você tem um servidor OAuth existente que suporta o fluxo de Código de Autorização.
• Você pode criar um novo endpoint de API que pode ser acessado pelo token de acesso OAuth retornado.

• Seus leitores de documentação também são seus editores de documentação.

Prós e Contras

Senha

Pros:

• Configuração super simples
• Nenhuma configuração necessária para adicionar novos usuários - basta compartilhar a senha

Cons:

• Difícil revogar o acesso à sua documentação sem redefinir a senha
• Perde recursos de personalização, pois não há como diferenciar usuários com a mesma senha

Pros:

• Configuração super simples
• Nenhuma configuração necessária para adicionar novos usuários - basta compartilhar a senha

Cons:

• Difícil revogar o acesso à sua documentação sem redefinir a senha
• Perde recursos de personalização, pois não há como diferenciar usuários com a mesma senha

Pros:

• Risco reduzido de abuso do endpoint da API
• Configuração CORS zero
• Sem restrições nas URLs da API

Cons:

• Deve ser capaz de se conectar ao seu fluxo de login existente

Pros:

• Padrão de segurança elevado

Cons:

• Requer trabalho significativo se estiver configurando o servidor OAuth pela primeira vez
• Pode ser excessivo para algumas aplicações

Pros:

• Configuração zero

Cons:

• Requer que todos os leitores da documentação tenham uma conta no seu dashboard do Mintlify