← 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

CampoTipoDescripción
idstring (uuid)Identificador único del usuario (UUID v7).
emailstring (email)Correo electrónico del usuario, usado para login y notificaciones.
namestringNombre completo del usuario tal como aparece en el panel.
rolestringRol del usuario en la organización. Determina los permisos disponibles. `owner` — dueño de la cuenta; `admin` — la administra; `user` — la usa; `viewer` — solo consulta.
statusstringEstado de la cuenta. Solo `active` permite operar la API. `suspended` — cuenta suspendida; `pending_verification` — falta verificar el correo.
timezonestringZona horaria IANA del usuario, usada para formatear timestamps en la UI.
languagestringIdioma preferido del usuario para UI y notificaciones. `es` para castellano, `en` para inglés.
email_verified_atstring | nullTimestamp ISO 8601 UTC de cuando el usuario verificó su email. `null` si pendiente.
created_atstring (date-time)Timestamp ISO 8601 UTC de creación de la cuenta.
api_keyobject | nullMetadatos de la API key. Nunca devuelve la key completa (usar POST /v1/users/me/api-key/reveal con password para revelar).
prefixstringPrefijo de la API key para identificación visual. No incluye la clave completa.
last_4string | nullÚltimos 4 caracteres de la API key para render enmascarado (`example_a1b••••••f9c2`). `null` en cuentas anteriores a que se guardara ese dato, hasta que se rellena.
subscriptionobject | nullSuscripción activa del usuario. `null` si no hay plan activo.
plan_slugstringIdentificador del plan contratado (free, pro, enterprise, etc.).
statusstringEstado actual de la suscripción según el ciclo de facturación. `active` — al corriente; `trialing` — en periodo de prueba; `past_due` — con un cobro pendiente; `canceled` — cancelada; `paused` — en pausa.
current_period_endstring | nullFin del periodo de billing actual (ISO 8601 UTC).
cancel_atstring | nullFecha programada de cancelación si el usuario inició cancel-at-period-end. `null` si no hay cancelación pendiente.
billing_intervalstring | nullFrecuencia de facturación del plan contratado. `month` cobra cada mes, `year` cada año y `once` marca un cobro único, sin renovación.
two_factorobjectEstado del segundo factor de autenticación.
enabledboolean`true` si el usuario tiene 2FA activado.
methodstring | nullCanal de entrega del OTP. `null` si 2FA está deshabilitado. `sms` manda el código por mensaje de texto; `email`, por correo.
last_used_atstring | nullÚltimo uso exitoso del 2FA. Campo futuro, hoy siempre `null`.
permissionsarrayLista plana de permisos del rol del usuario en formato `resource:action`.
notificationsobjectResumen de la cola de notificaciones del usuario.
unread_countintegerNúmero de notificaciones sin leer ni archivar.
push_enabledboolean`true` si el usuario tiene al menos una suscripción push activa.
telegram_linkedboolean`true` si el usuario tiene un chat de Telegram vinculado.
_warningsarrayLista 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