Étiquettes

Une étiquette est une paire clé = valeur, par exemple site = Lyon ou classe = 3A. Une étiquette de membre décrit une personne : elle fait entrer dans les groupes dynamiques et peut donner des rôles. Une étiquette de sensibilité se pose sur une ressource (base de connaissances, agent, serveur MCP, fichier) pour en limiter l’accès.

Toutes les routes sont sous https://chat.realmoon.ai/api/v1/orgs/{org_id}. Portées : labels:read pour lire, labels:write pour écrire.

L’objet étiquette#Lien vers la section L’objet étiquette

{
  "id": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "org_id": "8c1f2a4e-5b6d-4e7f-9a0b-1c2d3e4f5a6b",
  "key": "classe",
  "value": "3A",
  "color": "blue",
  "kind": "member",
  "source": "manual",
  "created_at": 1793836800
}

Deux étiquettes ne peuvent pas avoir la même clé et la même valeur (sans tenir compte de la casse). Dans les listes, chaque étiquette porte aussi member_count et assignment_count.

Lister les étiquettes#Lien vers la section Lister les étiquettes

GET /labels · labels:read

La réponse ajoute colors, la liste des couleurs permises.

Créer une étiquette#Lien vers la section Créer une étiquette

POST /labels · labels:write

Une organisation a 5 000 étiquettes au plus. Une étiquette qui existe déjà répond 409 invalid_request (« Cette étiquette existe déjà. »).

Modifier une étiquette#Lien vers la section Modifier une étiquette

PATCH /labels/{label_id} · labels:write

Champs facultatifs key, value, color et kind. Les membres et ressources étiquetés suivent la nouvelle clé ou valeur. Une étiquette nommée par la règle d’un groupe dynamique ne change ni de clé ni de valeur : 409 label_in_use, avec groups, les noms des groupes concernés. Changez d’abord leur règle.

Supprimer une étiquette#Lien vers la section Supprimer une étiquette

DELETE /labels/{label_id} · labels:write

Retire l’étiquette de tous les membres, groupes et ressources, et supprime les rôles qu’elle donnait. Réponse : {"success": true}. Refusé (409 label_in_use) tant qu’un groupe dynamique la nomme.

Poser une étiquette#Lien vers la section Poser une étiquette

POST /labels/{label_id}/assignments · labels:write

curl https://chat.realmoon.ai/api/v1/orgs/$ORG_ID/labels/$LABEL_ID/assignments \
  -H "Authorization: Bearer $MOONAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject_type": "user", "subject_ids": ["<id de membre>", "<id de membre>"]}'

import os
import requests

BASE = f"https://chat.realmoon.ai/api/v1/orgs/{os.environ['ORG_ID']}"
HEADERS = {"Authorization": f"Bearer {os.environ['MOONAI_ADMIN_KEY']}"}

r = requests.post(
    f"{BASE}/labels/{os.environ['LABEL_ID']}/assignments",
    headers=HEADERS,
    json={"subject_type": "user", "subject_ids": ["<id de membre>", "<id de membre>"]},
    timeout=30,
)
r.raise_for_status()
print(r.json()["added"])

const BASE = `https://chat.realmoon.ai/api/v1/orgs/${process.env.ORG_ID}`;
const r = await fetch(`${BASE}/labels/${process.env.LABEL_ID}/assignments`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.MOONAI_ADMIN_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ subject_type: 'user', subject_ids: ['<id de membre>', '<id de membre>'] }),
});
if (!r.ok) throw new Error(await r.text());
console.log((await r.json()).added);

Réponse : {"success": true, "added": 2}. Les sujets déjà étiquetés sont ignorés. Poser une étiquette sur des membres peut les faire entrer dans des groupes dynamiques et leur donner des rôles, tout de suite.

Poser une étiquette sur un groupe ou une ressource demande la permission de gérer les étiquettes ; sur des membres, celle de les poser.

Retirer une étiquette#Lien vers la section Retirer une étiquette

DELETE /labels/{label_id}/assignments · labels:write

Même corps que la pose (resource_type n’est pas lu). Réponse : {"success": true, "removed": 2}. Les sujets non étiquetés sont ignorés. Les membres peuvent sortir de groupes dynamiques et perdre des rôles.

Voir aussi#Lien vers la section Voir aussi

• Groupes
• Ressources, pour l’étiquette de sensibilité d’un serveur MCP ou d’un partage