Cierre de sesión de usuario
API operation: Open the endpoint in Scalar
Usa POST /auth/logout para invalidar la sesión autenticada actual. La operación pública actual es User.logout y requiere una clave de API aceptada o una sesión autenticada con bearer.
Todos los niveles de usuario documentados pueden invocar el cierre de sesión cuando están autenticados. Se puede impedir que un repartidor con pedidos en curso asignados cierre sesión hasta que esos pedidos se resuelvan.
Para eliminar un token de notificaciones push durante el cierre de sesión, envía el campo opcional actual de solicitud token_notification:
{
"token_notification": "<notification-token>"
}
El token es un marcador de posición. No coloques un token real de notificación o sesión en la documentación, el control de versiones ni una URL.
Ejemplo de SDK heredado:
const response = await ordering.users().logout()
Confirma el paquete y la versión del SDK antes de usar este helper. Scalar sigue siendo la fuente de autoridad para el contrato exacto POST /auth/logout.
Referencia de OpenAPI
Operación: POST /auth/logout
Parámetros de encabezado
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
User-Agent | string | No | — |
Campos del cuerpo de la solicitud
| Nombre | Tipo | Obligatorio |
|---|---|---|
token_notification | any | No |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON. |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Respuesta de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error: el proyecto no existe o no tiene una suscripción activa. |
| 403 | Respuesta de error: el módulo AI no está disponible para este proyecto. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1). |