← Volver al índice de esquemas

UserMeBundle

Bundle consolidado del usuario autenticado. Devuelto por GET /v1/users/me. Incluye perfil, metadatos de API key, suscripción activa, estado de 2FA, permisos del rol y resumen de notificaciones en un solo roundtrip.

Propiedades

Campo Tipo Descripción
id string (uuid) Identificador único del usuario (UUID v7).
email string (email) Correo electrónico del usuario, usado para login y notificaciones.
name string Nombre completo del usuario tal como aparece en el panel.
role string Rol del usuario en la organización. Determina los permisos disponibles.
status string Estado de la cuenta. Solo `active` permite operar la API.
timezone string Zona horaria IANA del usuario, usada para formatear timestamps en la UI.
language string Idioma preferido del usuario para UI y notificaciones.
email_verified_at string (date-time) Timestamp ISO 8601 UTC de cuando el usuario verificó su email. `null` si pendiente.
created_at string (date-time) Timestamp ISO 8601 UTC de creación de la cuenta.
api_key object Metadatos de la API key. Nunca devuelve la key completa (usar POST /v1/users/me/api-key/reveal con password para revelar).
prefix string Prefijo de la API key para identificación visual. No incluye la clave completa.
last_4 string Últimos 4 caracteres de la API key para render enmascarado (`veriko_a1b••••••f9c2`). `null` para usuarios pre-v1.49 hasta correr `bin/backfill-api-key-last-4.php`.
subscription object Suscripción activa del usuario. `null` si no hay plan activo.
plan_slug string Identificador del plan contratado (free, pro, enterprise, etc.).
status string Estado actual de la suscripción según el ciclo de billing.
current_period_end string (date-time) Fin del periodo de billing actual (ISO 8601 UTC).
cancel_at string (date-time) Fecha programada de cancelación si el usuario inició cancel-at-period-end. `null` si no hay cancelación pendiente.
billing_interval string Frecuencia de facturación del plan contratado.
two_factor object Estado del segundo factor de autenticación.
enabled boolean `true` si el usuario tiene 2FA activado.
method string Canal de entrega del OTP. `null` si 2FA está deshabilitado.
last_used_at string (date-time) Último uso exitoso del 2FA. Campo futuro, hoy siempre `null`.
permissions array Lista plana de permisos del rol del usuario en formato `resource:action`.
notifications object Resumen de la cola de notificaciones del usuario.
unread_count integer Número de notificaciones sin leer ni archivar.
push_enabled boolean `true` si el usuario tiene al menos una suscripción push activa.
telegram_linked boolean `true` si el usuario tiene un chat de Telegram vinculado.
_warnings array Lista de subsistemas que fallaron al construir este bundle. Solo presente si hubo fallos parciales. Los campos correspondientes a cada subsistema fallido estarán en su valor por defecto (null o vacío). Permite al cliente degradar gracefully en lugar de mostrar pantalla en blanco.

Usado en operaciones

  • GET /v1/users/me