Introducción

Recupera información sobre cuentas de administrador, sus roles y permisos.

Para más información sobre la interfaz de usuario del módulo, visita https://doc.oneentry.cloud/docs/category/administrators

---

🎯 ¿Qué hace este módulo?

El módulo Admins es solo lectura: recupera las cuentas de administrador de tu proyecto OneEntry y sus valores de atributos, con filtrado opcional. La creación de cuentas, la asignación de roles y la revocación de acceso se realizan en el panel de administración de OneEntry; este módulo SDK solo lee esa información para que tu aplicación pueda ver quién tiene acceso y qué puede hacer.

🚀 Inicio Rápido

Inicializa el módulo desde defineOneEntry:

const { Admins } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Recupera administradores, opcionalmente filtrados por condiciones de atributos:

// Filter body: admins whose "num" attribute is greater than 1.
const body = [
  { attributeMarker: "num", conditionMarker: "mth", conditionValue: 1 },
];

// getAdminsInfo(body, langCode, offset, limit) — all optional except defaults.
const admins = await Admins.getAdminsInfo(body, "en_US", 0, 30);

admins.forEach((admin) => {
  console.log(admin.id, admin.identifier);
});

Pasa un array vacío ([]) para el cuerpo cuando no necesites filtrado.

✨ Conceptos Clave

¿Qué es un Administrador?

Un administrador (admin) es una cuenta con acceso elevado para gestionar tu proyecto OneEntry. Cada admin expone:

• Identificador - el identificador único del admin
• Conjunto de atributos - el conjunto de atributos al que pertenece el admin (attributeSetIdentifier)
• Valores de atributos - los campos configurados (attributeValues)
• Roles / permisos - configurados en el panel de administración; el SDK los lee a través de los valores de atributos

Administrador vs Usuario Regular

Tipo	Propósito	Ejemplo
Administrador	Gestiona el sistema (backend)	Tú, los miembros de tu equipo
Usuario Regular	Usa tu aplicación/sitio web (frontend)	Tus clientes, visitantes del sitio web

Los admins gestionan contenido; Usuarios consumen contenido.

📋 Lo Que Necesitas Saber

Atributos del Admin

Cada objeto admin tiene estos campos clave:

{
  id: 123,                          // Unique admin ID
  attributeSetId: 27,               // Attribute set ID
  identifier: "admin",              // Unique identifier
  attributeSetIdentifier: "admins", // Attribute set identifier
  position: 1,                      // Position
  isSync: true,                     // Whether synced with the backend
  attributeValues: {}               // Attribute values
}

Filtrando administradores

Filtra a través del cuerpo de la solicitud — un array de condiciones, cada una combinando un attributeMarker, un conditionMarker, y un conditionValue (los mismos marcadores que el módulo Products):

Marcador	Significado	Ejemplo
eq	Igual	statusId = 1 (solo activos)
neq	No igual	role ≠ "Viewer"
in	Contiene (uno de)	role in ["Editor", "Manager"]
nin	No contiene	email not in ["@temp.com"]
mth	Más que (mayor)	createdYear > 2020
lth	Menos que	loginCount < 5
exs	Existe (tiene valor)	Tiene lastLogin
nexs	No existe	Nunca ha iniciado sesión

---

📊 Tabla de Referencia Rápida

Método	Descripción
getAdminsInfo()	Obtener cuentas de admin, con filtrado opcional

Parámetros

const body = [
  {
    "attributeMarker": "num",
    "conditionMarker": "mth",
    "conditionValue": 1
  }
];
const response = await Admins.getAdminsInfo(body, "en_US", 0, 30);

Esquema: (cuerpo)

attributeMarker: string
Identificador de texto del atributo
ejemplo: price

conditionMarker: string
Identificador de texto de la condición, valores posibles: 'in' - contiene, 'nin' - no contiene, 'eq' - igual, 'neq' - no igual, 'mth' - más que, 'lth' - menos que, 'exs' - existe, 'nexs' - no existe
ejemplo: in
Enum: [ in, nin, eq, neq, mth, lth, exs, nexs ]

conditionValue: number
Valor de la condición
ejemplo: 1

❓ Preguntas Comunes (FAQ)

¿Cuál es la diferencia entre los módulos Admins y Users?

• Admins - cuentas del equipo de backend que gestionan el sistema (solo lectura aquí).
• Users - cuentas de frontend que utilizan tu aplicación/sitio web (módulo Users).

---

¿Puedo crear o editar administradores con este módulo?

No. El módulo Admins es solo lectura. Crea cuentas, asigna roles y permisos, y revoca acceso en el panel de administración de OneEntry.

---

🎓 Mejores Prácticas

• Nunca expongas credenciales de admin o tokens privilegiados en el código del frontend.
• Usa filtros para obtener solo los admins que necesitas en lugar de la lista completa.
• Implementa el principio de menor privilegio al configurar roles en el panel de administración.

---

🔗 Documentación Relacionada

• Módulo Users - Gestiona cuentas de usuario de frontend
• Módulo AttributesSets - Conjuntos de atributos detrás de los campos de admin
• Panel de Administración de OneEntry - Administradores - Documentación oficial del panel de administración

---