Introdução

Recupere informações sobre contas de administrador, seus papéis e permissões.

Para mais informações sobre a interface do usuário do módulo, visite https://doc.oneentry.cloud/docs/category/administrators

---

🎯 O que este módulo faz?

O módulo Admins é somente leitura: ele recupera as contas de administrador do seu projeto OneEntry e seus valores de atributo, com filtragem opcional. A criação de contas, atribuição de papéis e revogação de acesso são feitas no painel de administração do OneEntry — este módulo SDK apenas lê essas informações para que seu aplicativo possa ver quem tem acesso e o que pode fazer.

🚀 Início Rápido

Inicialize o módulo a partir de defineOneEntry:

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

Recupere administradores, opcionalmente filtrados por condições de atributo:

// 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);
});

Passe um array vazio ([]) para o corpo quando não precisar de filtragem.

✨ Conceitos Chave

O que é um Administrador?

Um administrador (admin) é uma conta com acesso elevado para gerenciar seu projeto OneEntry. Cada admin expõe:

• Identificador - o identificador único do admin
• Conjunto de atributos - o conjunto de atributos ao qual o admin pertence (attributeSetIdentifier)
• Valores de atributos - os campos configurados (attributeValues)
• Papéis / permissões - configurados no painel de administração; o SDK os lê através dos valores de atributo

Administrador vs Usuário Regular

Tipo	Propósito	Exemplo
Administrador	Gerencia o sistema (backend)	Você, seus membros de equipe
Usuário Regular	Usa seu aplicativo/site (frontend)	Seus clientes, visitantes do site

Os admins gerenciam conteúdo; Usuários consomem conteúdo.

📋 O que você precisa saber

Atributos do admin

Cada objeto admin possui estes campos principais:

{
  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

Filtre através do corpo da requisição — um array de condições, cada uma combinando um attributeMarker, um conditionMarker e um conditionValue (mesmos marcadores que o módulo Products):

Marcador	Significado	Exemplo
eq	Igual	statusId = 1 (somente ativo)
neq	Não igual	role ≠ "Viewer"
in	Contém (um dos)	role in ["Editor", "Manager"]
nin	Não contém	email not in ["@temp.com"]
mth	Mais que (maior)	createdYear > 2020
lth	Menos que	loginCount < 5
exs	Existe (tem valor)	Tem lastLogin
nexs	Não existe	Nunca fez login

---

📊 Tabela de Referência Rápida

Método	Descrição
getAdminsInfo()	Obter contas de admin, com filtragem opcional

Parâmetros

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

Esquema: (corpo)

attributeMarker: string
Identificador de texto do atributo
exemplo: price

conditionMarker: string
Identificador de texto da condição, valores possíveis: 'in' - contém, 'nin' - não contém, 'eq' - igual, 'neq' - não igual, 'mth' - mais que, 'lth' - menos que, 'exs' - existe, 'nexs' - não existe
exemplo: in
Enum: [ in, nin, eq, neq, mth, lth, exs, nexs ]

conditionValue: number
Valor da condição
exemplo: 1

❓ Perguntas Comuns (FAQ)

Qual é a diferença entre os módulos Admins e Users?

• Admins - contas da equipe de backend que gerenciam o sistema (somente leitura aqui).
• Users - contas de frontend que usam seu aplicativo/site (módulo Users).

---

Posso criar ou editar admins com este módulo?

Não. O módulo Admins é somente leitura. Crie contas, atribua papéis e permissões, e revogue acesso no painel de administração do OneEntry.

---

🎓 Melhores Práticas

• Nunca exponha credenciais de admin ou tokens privilegiados no código do frontend.
• Use filtros para buscar apenas os admins que você precisa, em vez da lista completa.
• Implemente o princípio do menor privilégio ao configurar papéis no painel de administração.

---

🔗 Documentação Relacionada

• Módulo Users - Gerenciar contas de usuários do frontend
• Módulo AttributesSets - Conjuntos de atributos por trás dos campos de admin
• Painel de Administração do OneEntry - Administradores - Documentação oficial do painel de administração

---