Realms

Realms are the tenants of KATFORGE. A realm has public metadata (slug, name, mode) and optional branding (logo, colors, legal URLs) used by login and consent UIs for white-labeling.

See Realms (platform) for the conceptual model.

Metadata

GET /v1/realms/{slug}

Get a realm's public metadata.

• Auth: Public

Path params: slug — realm slug.

Response — 200 OK

{
   "realm": {
      "slug": "stumper",
      "name": "Stumper",
      "mode": "hosted",
      "is_active": true
   }
}

Field	Meaning
mode	hosted or shadow. hosted realms run on KATFORGE infrastructure; shadow realms reuse an external identity provider.

Errors

Branding

GET /v1/realms/{slug}/branding

Get a realm's branding overrides for the login and consent UIs.

• Auth: Public

Response — 200 OK

{
   "branding": {
      "display_name": "Stumper",
      "logo_url": "https://cdn.stumper.gg/logo.svg",
      "primary_color": "#f97316",
      "privacy_url": "https://stumper.gg/privacy",
      "terms_url": "https://stumper.gg/terms",
      "support_email": "support@stumper.gg",
      "frontend_url": "https://stumper.gg"
   }
}

Any field may be null if the realm hasn't configured an override.

Errors