Choosing a handshake

Esta es la documentación para los métodos deAutenticaciónHandshake. La personalización ofrece unconjunto diferente de métodos Handshake.

Antes de que sus usuarios puedan acceder al contenido personalizado, deben ser autenticados. Mintlify admite cuatro métodos de Handshake de Autenticación:

1. Contraseña: Configure un conjunto de contraseñas globales para su sitio de documentación.
2. JWT: Utilice su propio flujo de inicio de sesión para autenticar a sus usuarios mediante un JWT en la URL.
3. OAuth 2.0: Integre con su servidor OAuth para habilitar el inicio de sesión de usuarios a través del flujo estándar de Código de Autorización.
4. Panel de Control de Mintlify: Permita que todos los usuarios de su panel de control accedan a su documentación, sin configuración requerida.

Requisitos previos

Contraseña

• Sus requisitos de seguridad permiten compartir contraseñas entre los lectores de la documentación.

• Sus requisitos de seguridad permiten compartir contraseñas entre los lectores de la documentación.

• Tiene algún flujo de inicio de sesión existente.
• Puede agregar un paso final en este flujo de inicio de sesión que cree un JWT y redirija a la documentación.

• Tiene un servidor OAuth existente que admite el flujo de Código de Autorización.
• Puede crear un nuevo endpoint de API al que se pueda acceder con el token de acceso OAuth devuelto.

• Sus lectores de documentación también son sus editores de documentación.

Pros y Contras

Contraseña

Pros:

• Configuración super simple
• No se requiere configuración para agregar nuevos usuarios - solo comparta la contraseña

Cons:

• Difícil revocar el acceso a su documentación sin restablecer la contraseña
• Se pierden las características de personalización, ya que no hay forma de diferenciar a los usuarios con la misma contraseña

Pros:

• Configuración super simple
• No se requiere configuración para agregar nuevos usuarios - solo comparta la contraseña

Cons:

• Difícil revocar el acceso a su documentación sin restablecer la contraseña
• Se pierden las características de personalización, ya que no hay forma de diferenciar a los usuarios con la misma contraseña

Pros:

• Riesgo reducido de abuso del endpoint de API
• Configuración CORS cero
• Sin restricciones en las URL de API

Cons:

• Debe poder conectarse a su flujo de inicio de sesión existente

Pros:

• Estándar de seguridad elevado

Cons:

• Requiere trabajo significativo si se configura el servidor OAuth por primera vez
• Puede ser excesivo para algunas aplicaciones

Pros:

• Configuración cero

Cons:

• Requiere que todos los lectores de documentación tengan una cuenta en su panel de control de Mintlify