Rolebase Développeurs
Référence API

org

L'entité de niveau supérieur qui contient toutes les autres entités telles que les cercles, rôles, membres, réunions et tâches.

Champs

Champ Type Description
id uuid Identifiant unique de l'organisation
name String Nom de l'organisation
slug String Identifiant unique adapté aux URL (optionnel)
archived Boolean Indique si l'organisation est archivée (par défaut : false)
createdAt Timestamp Date de création de l'organisation
defaultGraphView String Paramètre de vue graphique par défaut (optionnel)
protectGovernance Boolean Indique si les modifications de gouvernance sont restreintes aux leaders (par défaut : false)
shareMembers Boolean Indique si les informations des membres sont partagées publiquement (par défaut : false)
shareOrg Boolean Indique si les informations de l'organisation sont partagées publiquement (par défaut : false)

Relations

Un-à-un :

  • org_subscription — Informations d’abonnement de l’organisation

Un-à-plusieurs :

  • circles — Cercles organisationnels
  • decisions — Décisions de l’organisation
  • files — Fichiers de l’organisation
  • logs — Journaux d’activité
  • meeting_templates — Modèles de réunion
  • meetings — Réunions
  • meetings_recurring — Réunions récurrentes
  • members — Membres de l’organisation
  • news — Actualités
  • roles — Rôles de l’organisation
  • task_views — Vues de tâches
  • tasks — Tâches
  • threads — Fils de discussion

Exemples de requêtes

Obtenir une organisation spécifique

query GetOrganization($id: uuid!) {
  org_by_pk(id: $id) {
    id
    name
    slug
    archived
    createdAt
    members {
      id
      name
      role
    }
    circles {
      id
      name
    }
  }
}

Exemples de mutations

Mettre à jour une organisation

mutation UpdateOrganization {
  update_org_by_pk(
    pk_columns: { id: "your-org-id" }
    _set: {
      name: "New Organization Name"
      shareMembers: true
      protectGovernance: true
    }
  ) {
    id
    name
    shareMembers
    protectGovernance
  }
}

Permissions

  • Propriétaire : Accès complet à tous les paramètres et données de l’organisation
  • Administrateur : Peut gérer la plupart des paramètres et données de l’organisation
  • Membre : Peut consulter les données de l’organisation selon les paramètres de partage
Info Circle Notes

Le champ slug doit être unique parmi toutes les organisations. Lorsque protectGovernance est activé, seuls les leaders de cercle peuvent modifier les entités liées à la gouvernance. Les indicateurs shareMembers et shareOrg contrôlent la visibilité des données de l’organisation pour les utilisateurs externes.