Configuración de autenticación

​

Requisitos previos

• Toda persona que necesite acceder a tu documentación debe ser miembro de tu organización de Mintlify.

​

Implementación

​

Ejemplo

​

Requisitos previos

• Un servidor OAuth u OIDC que admita el flujo Authorization Code.
• Posibilidad de crear un endpoint de API accesible mediante tokens de acceso de OAuth (opcional, para habilitar funciones de personalización).

​

Implementación

​

Ejemplo

• Authorization URL: https://auth.foo.com/authorization
• Client ID: ydybo4SD8PR73vzWWd6S0ObH
• Scopes: ['provider.users.docs']
• Token URL: https://auth.foo.com/exchange
• Info API URL: https://api.foo.com/docs/user-info
• Logout URL: https://auth.foo.com/logout?returnTo=https%3A%2F%2Ffoo.com%2Fdocs

{
  "content": {
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "groups": ["engineering", "admin"]
}

​

Requisitos previos

• Un sistema de autenticación que pueda generar y firmar JWT.
• Un servicio de backend que pueda crear URL de redirección.

​

Implementación

​

Ejemplo

• Genera un JWT con los datos del usuario en el formato de Mintlify.
• Firma el JWT y redirige a https://docs.foo.com/login/jwt-callback#{SIGNED_JWT}.

import * as jose from 'jose';
import { Request, Response } from 'express';

const TWO_WEEKS_IN_MS = 1000 * 60 * 60 * 24 * 7 * 2;

const signingKey = await jose.importPKCS8(process.env.MINTLIFY_PRIVATE_KEY, 'EdDSA');

export async function handleRequest(req: Request, res: Response) {
  const user = {
    expiresAt: Math.floor((Date.now() + TWO_WEEKS_IN_MS) / 1000), // Expiración de sesión de 2 semanas
    groups: res.locals.user.groups,
    content: {
      firstName: res.locals.user.firstName,
      lastName: res.locals.user.lastName,
    },
  };

  const jwt = await new jose.SignJWT(user)
    .setProtectedHeader({ alg: 'EdDSA' })
    .setExpirationTime('10 s') // Expiración del JWT de 10 segundos
    .sign(signingKey);

  return res.redirect(`https://docs.foo.com/login/jwt-callback#${jwt}`);
}

​

Redirigir a usuarios no autenticados

1. El usuario intenta visitar una página protegida: https://docs.foo.com/quickstart.
2. Redirige a tu URL de inicio de sesión con un parámetro query de redirección: https://foo.com/docs-login?redirect=%2Fquickstart.
3. Después de la autenticación, redirige a https://docs.foo.com/login/jwt-callback?redirect=%2Fquickstart#{SIGNED_JWT}.
4. El usuario llega a su destino original.