← Volver al índice de esquemas
UserMeBundle
Conjunto consolidado del usuario autenticado que devuelve `GET /v1/users/me`: perfil, metadatos de la clave de API, suscripción activa, estado de la autenticación de 2 factores (2FA), permisos del rol y resumen de notificaciones en una sola llamada.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
id | string (uuid) | Identificador único del usuario (UUID v4). |
email | string (email) | Correo electrónico asociado a la cuenta de usuario (con el que se inicia sesión y se reciben notificaciones). |
name | string | Nombre con el que se presenta a la cuenta de usuario en la interfaz (máximo 100 caracteres). |
role | string | Rol de la cuenta de usuario en la organización. Decide qué permisos tienen sus sesiones — `owner`: Es la titular; `admin`: La administra; `user`: La usa. |
status | string | Estado de la cuenta de usuario — `active`: Permite operar con normalidad; `suspended`: Cuenta suspendida; `revoked`: Eliminada por el usuario. |
timezone | string | Zona horaria IANA con la que se presentan las fechas al usuario. |
language | string | null | Idioma preferido de la cuenta de usuario para mostrar la interfaz y notificaciones — `es`: Castellano; `en`: Inglés; `null`: La cuenta de usuario aún no ha elegido idioma preferido. |
email_verified_at | string | null | Fecha y hora de la verificación del correo electrónico de la cuenta de usuario (en ISO 8601 UTC). `null` cuando sigue pendiente. |
created_at | string (date-time) | Fecha y hora del alta de la cuenta de usuario, en ISO 8601 UTC. |
api_key | object | null | Datos de la clave de API de la cuenta de usuario. Nunca contiene la clave completa: para eso está `POST /v1/users/me/api-key/reveal`, que exige la contraseña. |
prefix | string | Primeros 8 caracteres de la clave de API. |
last_4 | string | null | Últimos 4 caracteres de la clave de API, con los que se pinta enmascarada (`example_a1b2••••••f9c2`). `null` en las cuentas anteriores a ese campo, hasta que se rellena. |
subscription | object | null | Suscripción activa de la cuenta de usuario. Cuando no hay ninguna, contiene los valores del plan predeterminado del sistema, y solo es `null` cuando no se pudo consultar — el caso que `_warnings` reporta. |
plan_slug | string | Identificador único y legible del plan. |
plan_name | string | null | Nombre visible del plan activo, tal como lo muestra el catálogo de planes. Es `null` cuando no se pudo leer el catálogo. |
status | string | Estado actual de la suscripción según el ciclo de facturación. `active`: Al corriente; `trialing`: En periodo de prueba; `past_due`: Con cobros pendientes; `canceled`: Cancelada; `paused`: En pausa. |
current_period_end | string | null | Fecha y hora del fin del periodo de facturación en curso, en ISO 8601 UTC. |
cancel_at | string | null | Fecha y hora de la cancelación programada, en ISO 8601 UTC. `null` cuando no hay ninguna pendiente. |
billing_interval | string | null | Cadencia de facturación — `once`: Ciclo único, sin renovación automática; `month`: Cada mes; `year`: Cada año. |
two_factor | object | Estado de la autenticación de 2 factores (2FA). |
enabled | boolean | `true` cuando la autenticación de 2 factores (2FA) está activa en la cuenta. |
method | string | null | Canal por el que se entrega el código de autenticación (OTP) — `sms`: Por mensaje de texto; `email`: Por correo electrónico; `null`: La cuenta de usuario nunca lo ha configurado. Al desactivar la 2FA se conserva el último canal usado. |
last_used_at | string | null | Fecha y hora del último uso de la autenticación de 2 factores (2FA), en ISO 8601 UTC. Campo previsto para más adelante: hoy siempre `null`. |
permissions | array | Lista plana de permisos del rol asignado a la cuenta de usuario (en formato `resource:action`). |
notifications | object | Resumen de la cola de notificaciones del usuario. |
unread_count | integer | Cantidad de notificaciones del usuario sin leer ni archivar. |
push_enabled | boolean | `true` cuando la cuenta tiene al menos una suscripción de notificaciones push activa. |
telegram_linked | boolean | `true` cuando la cuenta de usuario tiene un chat de Telegram vinculado. |
legal_accepted | boolean | `true` cuando no queda pendiente la aceptación de ningún documento: ni los Términos de Servicio ni el Aviso de Privacidad. `false` cuando falta la aceptación de cualquiera de los dos, o cuando el equipo exigió aceptar una versión que la cuenta todavía no ha aceptado. Gatea el modal de consentimiento post-login, que lista lo pendiente en `GET /users/me/legal/pending`. |
_warnings | array | Piezas que no se pudieron calcular en la respuesta. Solo aparece cuando algo falló, y los campos que dependían de ella llegan en su valor vacío (`null` o lista vacía). |
Usado en operaciones
GET /v1/users/me