Esta es la documentación para elPersonalization Handshake de OAuth. Los pasos para configurar elOAuthAuthentication Handshake son ligeramente diferentes.

Si tienes un servidor OAuth existente que soporta el flujo PKCE, puedes integrarlo con Mintlify para una experiencia de inicio de sesión sin problemas.

​
Implementación

1

Crea tu API de Información

Crea un endpoint de API que pueda ser accedido con un token de acceso OAuth, y responda con una carga útil JSON siguiendo el formatoUser. Toma nota del alcance o alcances requeridos para acceder a este endpoint.

2

Configura tus ajustes de Personalización

Ve a tudashboard settings, selecciona la opción OAuth, y completa los campos requeridos:

  • Authorization URL: La URL base para la solicitud de autorización, a la cual agregaremos los parámetros de consulta apropiados.
  • Client ID: Un ID para el cliente OAuth 2.0 que se utilizará.
  • Scopes: Un array de alcances que serán solicitados.
  • Token URL: La URL base para la solicitud de intercambio de token.
  • Info API URL: El endpoint que se utilizará para recuperar la información del usuario.
3

Configura tu cliente OAuth

Copia la Redirect URL listada en eldashboard settings y agrégala como una URL de redirección autorizada para tu servidor OAuth.

​
Ejemplo

Tengo un servidor OAuth existente que soporta el flujo PKCE. Quiero configurar la autenticación para mis documentos alojados enfoo.com/docs.

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

Luego voy a la configuración del panel, navego a los ajustes de Personalización, selecciono OAuth, e ingreso los valores relevantes para el flujo OAuth y el endpoint de la API de Información:

  • Authorization URL:https://auth.foo.com/authorization
  • Client ID:ydybo4SD8PR73vzWWd6S0ObH
  • Scopes:['docs-user-info']
  • Token URL:https://auth.foo.com/exchange
  • Info API URL:https://api.foo.com/docs/user-info

Finalmente, copio la Redirect URL 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.