Esta es la documentación para el Protocolo de Autenticación Authentication OAuth. Los pasos para configurar el Protocolo de OAuth Personalization son ligeramente diferentes.

Si tiene un servidor OAuth existente, puede integrarlo con Mintlify para una experiencia de inicio de sesión sin problemas.

​
Implementación

1

Configure sus ajustes de Autenticación

Vaya a su configuración de autenticación de Mintlify, seleccione la opción OAuth y complete los campos requeridos:

  • URL de Autorización: La URL base para la solicitud de autorización, a la que agregaremos los parámetros de consulta apropiados.
  • ID del Cliente: Un ID para el cliente OAuth 2.0 que se utilizará.
  • Ámbitos: Un array de ámbitos que se solicitarán.
  • URL del Token: La URL base para la solicitud de intercambio de token.
  • URL de la API de Información (opcional): El punto final que se utilizará para recuperar la información del usuario. Si se omite, el flujo OAuth solo se utilizará para verificar la identidad, y la información del usuario estará vacía.
2

Configure su cliente OAuth

Copie la URL de Redirección listada en la configuración de autenticación de Mintlify y agréguela como una URL de redirección autorizada para su servidor OAuth.

3

Cree su API de Información (Opcional)

Si desea aprovechar las funciones de personalización de la autenticación, necesitará crear un punto final para recuperar información sobre sus usuarios. Cree un punto final de API que pueda ser accedido con un token de acceso OAuth y responda con una carga útil JSON siguiendo el formato User.

Vuelva a su configuración de autenticación de Mintlify y agregue la URL de la API de Información a su configuración de OAuth.

​
Ejemplo

Tengo un servidor OAuth existente que admite el flujo de Código de Autorización. Quiero configurar la autenticación para mis documentos alojados en foo.com/docs.

Para configurar la autenticación con Mintlify, creo un punto final api.foo.com/docs/user-info que requiere un token de acceso OAuth con el ámbito docs-user-info y responde con los datos personalizados del usuario según la especificación de Mintlify.

Luego voy al panel de configuración, navego a la configuración de Autenticación, selecciono OAuth e ingreso los valores relevantes para el flujo OAuth y el punto final de la API de información:

  • URL de autorización: https://auth.foo.com/authorization
  • ID de cliente: ydybo4SD8PR73vzWWd6S0ObH
  • Ámbitos: ['docs-user-info']
  • URL del token: https://auth.foo.com/exchange
  • URL de la API de información: https://api.foo.com/docs/user-info

Finalmente, copio la URL de redirección mostrada en la configuración del panel y la agrego como una URL de redirección autorizada en la configuración de mi cliente OAuth.