Skip to content

Realms ​

Realms are organizational containers in FLAME Hub that group identity providers, robots, users, roles, and nodes. They are managed through Authup and enforced across all Hub services.

Overview ​

Realms overview

Each realm is an isolated organizational unit. Resources created within a realm (projects, analyses, nodes) are scoped to that realm. Which realms a user or client reaches is decided per permission by the grant's realm scope, not by the realm they belong to — the master realm is not special.

Managing Realms ​

Creating a Realm ​

Add realm

Realm Details ​

Realm details

Realm Scoping ​

All realm-scoped entities carry a realmId property (the realm_id column). Every permission a role or client holds is granted with a realm_scope, and that scope decides which records the permission reaches:

any        →  every realm, and records without a realm
ownOrNull  →  the holder's own realm, and records without a realm
own        →  the holder's own realm
none       →  no realm

The built-in admin role and the system client hold their permissions at any. A record out of reach answers 403 on a write; reads only return what is in reach. Analyses add participation on top: the realms of an analysis' nodes reach it too (see Analyses).

Users ​

Users overview

Users are human accounts within a realm. Administrators can manage users, assign roles, and view details.

User details

User roles

Add user

Robots ​

Robots are API pseudo-users for automation. They belong to a realm and are assigned roles and permissions just like human users.

Robots overview

Use robots for:

  • Automated pipelines that interact with the Hub API
  • Service-to-service communication
  • CI/CD integrations

Robot details

Robot roles

Robot permissions

Add robot

Roles & Permissions ​

Hub uses role-based access control (RBAC) via Authup:

  • Roles group related permissions and are assigned to users or robots within a realm
  • Permissions are pre-defined actions (e.g., node_create, analysis_update) checked at the service layer
  • Two-phase permission model: preEvaluate (fast fail) then evaluate (with policy attributes)

Permissions

Identity Providers ​

Each realm can configure OIDC identity providers for federated authentication. Users authenticate through their realm's identity provider, and Authup maps the external identity to a Hub user.