Aller au contenu principal

Introduction

Récupérez des informations sur les comptes administrateurs, leurs rôles et permissions.

Pour plus d'informations sur l'interface utilisateur du module, visitez https://doc.oneentry.cloud/docs/category/administrators


🎯 Que fait ce module ?

Le module Admins est en lecture seule : il récupère les comptes administrateurs de votre projet OneEntry et leurs valeurs d'attribut, avec un filtrage optionnel. La création de comptes, l'attribution de rôles et la révocation d'accès se font toutes dans le panneau d'administration OneEntry — ce module SDK ne fait que lire ces informations afin que votre application puisse voir qui a accès et ce qu'ils peuvent faire.

🚀 Démarrage rapide

Initialisez le module à partir de defineOneEntry :


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

Récupérez les admins, filtrés optionnellement par des conditions d'attribut :

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

Passez un tableau vide ([]) pour le corps lorsque vous n'avez pas besoin de filtrage.

✨ Concepts clés

Qu'est-ce qu'un Administrateur ?

Un administrateur (admin) est un compte avec un accès élevé pour gérer votre projet OneEntry. Chaque admin expose :

  • Identifiant - l'identifiant unique de l'admin
  • Ensemble d'attributs - l'ensemble d'attributs auquel appartient l'admin (attributeSetIdentifier)
  • Valeurs d'attributs - les champs configurés (attributeValues)
  • Rôles / permissions - configurés dans le panneau d'administration ; le SDK les lit via les valeurs d'attribut

Administrateur vs Utilisateur Régulier

TypeObjectifExemple
AdministrateurGère le système (backend)Vous, vos membres d'équipe
Utilisateur RégulierUtilise votre application/site (frontend)Vos clients, visiteurs du site

Les admins gèrent le contenu ; Users consomment le contenu.

📋 Ce que vous devez savoir

Attributs des admins

Chaque objet admin a ces champs clés :

{
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
}

Filtrage des admins

Filtrez à travers le corps de la requête — un tableau de conditions, chacune combinant un attributeMarker, un conditionMarker, et un conditionValue (mêmes marqueurs que le module Products) :

MarqueurSignificationExemple
eqÉgalstatusId = 1 (actif uniquement)
neqPas égalrole ≠ "Viewer"
inContient (un des)role in ["Editor", "Manager"]
ninNe contient pasemail not in ["@temp.com"]
mthPlus que (supérieur)createdYear > 2020
lthMoins queloginCount < 5
exsExiste (a une valeur)A un lastLogin
nexsN'existe pasJamais connecté

📊 Tableau de référence rapide

MéthodeDescription
getAdminsInfo()Obtenir des comptes admin, avec filtrage optionnel

Paramètres


const body = [
{
"attributeMarker": "num",
"conditionMarker": "mth",
"conditionValue": 1
}
];

const response = await Admins.getAdminsInfo(body, "en_US", 0, 30);

Schéma : (body)

attributeMarker: string
Identifiant textuel de l'attribut
exemple : price

conditionMarker: string
Identifiant textuel de la condition, valeurs possibles : 'in' - contient, 'nin' - ne contient pas, 'eq' - égal, 'neq' - pas égal, 'mth' - plus que, 'lth' - moins que, 'exs' - existe, 'nexs' - n'existe pas
exemple : in
Enum : [ in, nin, eq, neq, mth, lth, exs, nexs ]

conditionValue: number
Valeur de condition
exemple : 1

❓ Questions fréquentes (FAQ)

Quelle est la différence entre les modules Admins et Users ?

  • Admins - comptes de l'équipe backend qui gèrent le système (lecture seule ici).
  • Users - comptes frontend qui utilisent votre application/site (Users module).

Puis-je créer ou modifier des admins avec ce module ?

Non. Le module Admins est en lecture seule. Créez des comptes, attribuez des rôles et permissions, et révoquez l'accès dans le panneau d'administration OneEntry.


🎓 Meilleures pratiques

  • Ne jamais exposer les identifiants d'administrateur ou les jetons privilégiés dans le code frontend.
  • Utilisez des filtres pour récupérer uniquement les admins dont vous avez besoin plutôt que la liste complète.
  • Mettez en œuvre le principe du moindre privilège lors de la configuration des rôles dans le panneau d'administration.

🔗 Documentation connexe