Skip to content
MSO CloudDocumentation

Administration

On this page

Platform administration, organization data and backup, menus, blueprints, appearance and masking.

apiTokens#

Source: apps/web/src/server/routers/api-tokens.ts

Procedure Type Access Description
apiTokens.list query orgProcedure, manage_org_settings —
apiTokens.create mutation rateLimitedOrgProcedure, manage_org_settings —
apiTokens.revoke mutation rateLimitedOrgProcedure, manage_org_settings —

admin#

Source: apps/web/src/server/routers/admin.ts

Procedure Type Access Description
admin.overview query superAdminProcedure —
admin.listOrganizations query superAdminProcedure —
admin.organizationBlueprints query superAdminProcedure blueprint provenance for one org — the per-row detail read.
admin.organizationAiStatus query superAdminProcedure A cross-org ai_configs scan is denied by the real nobypassrls app role.
admin.createOrganization mutation superAdminProcedure —
admin.applyBlueprint mutation superAdminProcedure Re-apply a provisioning blueprint to an existing org.
admin.previewBlueprint query superAdminProcedure —
admin.updateOrganization mutation superAdminProcedure —
admin.tenantConfig query superAdminProcedure —
admin.listOrgDomains query superAdminProcedure Every white-label domain row for an org (org-scoped RLS → withOrgContext).
admin.addOrgDomain mutation superAdminProcedure Register a customer-owned white-label domain.
admin.verifyOrgDomain mutation superAdminProcedure —
admin.removeOrgDomain mutation superAdminProcedure —
admin.listPlugins query superAdminProcedure —
admin.togglePlugin mutation superAdminProcedure —
admin.toggleOrgLdap mutation superAdminProcedure —
admin.getOrgLdapStatus query superAdminProcedure Super-admin read of an org's LDAP entitlement + whether it is configured.
admin.toggleOrgOidc mutation superAdminProcedure —
admin.getOrgOidcStatus query superAdminProcedure Super-admin read of an org's OIDC provider rows — entitlement + whether each is configured.
admin.toggleOrgWhiteLabel mutation superAdminProcedure —
admin.setOrgPdfFooterBrand mutation superAdminProcedure The org's own brand name in an exported PDF's footer.
admin.getOrgWhiteLabelStatus query superAdminProcedure Super-admin read of an org's white-label entitlement, whether a login-page config has ever been published, and the current PDF footer override.
admin.mintMcpToken mutation superAdminProcedure MCP tokens (super-admin only)
admin.listMcpTokens query superAdminProcedure —
admin.revokeMcpToken mutation superAdminProcedure —
admin.deleteOrganization mutation superAdminProcedure —
admin.listUsers query superAdminProcedure —
admin.userDetail query superAdminProcedure one person, keyed on their id — the detail read the drawers open with.
admin.organizationDetail query superAdminProcedure one org, keyed on its id — the org drawer's record, not a list read.
admin.listMemberships query superAdminProcedure the membership directory — assignments, searched and paged by the server.
admin.listOrgBrands query superAdminProcedure Assignable brands of one org, for the membership brand-scope picker.
admin.demoIdentity query superAdminProcedure What a demo member reads in place of the org and each brand; positions match the posture's alias order.
admin.updateDemoIdentity mutation superAdminProcedure —
admin.listRolePolicies query superAdminProcedure —
admin.rolePolicyCatalog query superAdminProcedure —
admin.orgMenuAvailability query superAdminProcedure —
admin.updateRolePolicy mutation superAdminProcedure —
admin.bulkSetMenuItemVisibility mutation superAdminProcedure Bulk hide/show a menu item across every role in an org with a single call.
admin.upsertMembership mutation superAdminProcedure —
admin.updateMembershipRole mutation superAdminProcedure —
admin.removeMembership mutation superAdminProcedure —
admin.updateUserAccount mutation superAdminProcedure —
admin.setUserPassword mutation superAdminProcedure —
admin.resendUserInvitation mutation superAdminProcedure —
admin.deleteUserAccount mutation superAdminProcedure —
admin.toggleSuperAdmin mutation superAdminProcedure —
admin.orgSnapshot query superAdminProcedure —
admin.connectorMedallion query superAdminProcedure Per-connector medallion (Bronze → Silver → Gold) status for an org.
admin.systemHealth query superAdminProcedure —
admin.orgHealth query superAdminProcedure —
admin.triggerConnectorSync mutation superAdminProcedure Manually enqueue a one-shot sync for a connector.
admin.listAuditLogs query superAdminProcedure —
admin.browseTable query superAdminProcedure One page of an org's rows for the /admin/data browser.
admin.orgDataScope query superAdminProcedure —
admin.sampleDataStatus query superAdminProcedure Lightweight probe used by the /admin/data SampleDataPanel to decide which buttons to render.
admin.seedSampleData mutation superAdminProcedure —
admin.removeSampleData mutation superAdminProcedure —

siteIdentity#

Source: apps/web/src/server/routers/site-identity.ts

Procedure Type Access Description
siteIdentity.get query publicProcedure Public read — chrome of every page depends on this.
siteIdentity.getForAdmin query superAdminProcedure Super-admin read includes the audit metadata.
siteIdentity.update mutation superAdminProcedure —
siteIdentity.setTokenRefreshDisabled mutation superAdminProcedure Super-admin kill-switch for OAuth token refresh.

appearance#

Source: apps/web/src/server/routers/appearance.ts

Procedure Type Access Description
appearance.list query superAdminProcedure Built-ins + custom rows of one cohort + the active slug.
appearance.get query superAdminProcedure A single skin (built-in, or a custom row of the addressed cohort).
appearance.create mutation superAdminProcedure —
appearance.update mutation superAdminProcedure —
appearance.delete mutation superAdminProcedure —
appearance.activate mutation superAdminProcedure —
appearance.exportThemes mutation superAdminProcedure —
appearance.importThemes mutation superAdminProcedure Import an untrusted bundle into the platform cohort, or (with orgId) into one org's own catalogue.
appearance.selfList query orgProcedure, owner or admin This org's own skins.
appearance.selfCreateTheme mutation rateLimitedOrgProcedure, owner or admin —
appearance.selfUpdateTheme mutation rateLimitedOrgProcedure, owner or admin —
appearance.selfDeleteTheme mutation rateLimitedOrgProcedure, owner or admin —
appearance.selfExportThemes mutation rateLimitedOrgProcedure, owner or admin —
appearance.selfImportThemes mutation rateLimitedOrgProcedure, owner or admin Import a bundle as this org'S own skins — same mechanics as the platform importer (importBundleIntoCohort), only the cohort differs.

platformConnectors#

Source: apps/web/src/server/routers/platform-connectors.ts

Procedure Type Access Description
platformConnectors.trendFeed.status query superAdminProcedure —
platformConnectors.trendFeed.setCredential mutation superAdminProcedure —
platformConnectors.trendFeed.clearCredential mutation superAdminProcedure —
platformConnectors.trendFeed.testCredential mutation superAdminProcedure One login and one list call through the shared session and call budget; answers codes and latency, never vendor text.
platformConnectors.trendFeed.runNow mutation superAdminProcedure —
platformConnectors.trendFeed.heldRows query superAdminProcedure —
platformConnectors.trendFeed.decide mutation superAdminProcedure —
platformConnectors.trendFeed.undo mutation superAdminProcedure —
platformConnectors.trendFeed.orgTopics query superAdminProcedure —
platformConnectors.trendFeed.setOrgTopics mutation superAdminProcedure —

orgData#

Source: apps/web/src/server/routers/org-data.ts

Procedure Type Access Description
orgData.planPreview query superAdminProcedure —
orgData.backupRequest mutation superAdminProcedure —
orgData.jobs query superAdminProcedure Recent backup/restore jobs, newest first (capped at 50).
orgData.restoreIdentityPreview query superAdminProcedure Does an into_same_org restore of this artifact need the operator to say how row identities are handled?
orgData.job query superAdminProcedure A single job (poll one job's live progress).
orgData.downloadUrl mutation superAdminProcedure Mint a short-lived (≤15m) presigned download URL for a completed backup artifact.
orgData.deleteArtifact mutation superAdminProcedure Delete only terminal, non-retrying states, and require the physical object cleanup to succeed.
orgData.restoreRequest mutation superAdminProcedure —
orgData.cancel mutation superAdminProcedure Cancel a job before the worker has picked it up.
orgData.selfPlanPreview query orgProcedure, owner or admin The org's own scope preview — the same three facts Admin cp resolves (groups, sizes, relevance), for the tenant the caller is in.
orgData.selfJobList query orgProcedure, owner or admin —
orgData.selfBackupRequest mutation rateLimitedOrgProcedure, owner or admin —
orgData.selfArtifactDownload mutation authedProcedure, owner or admin Presigned download of the caller's own artifact — org-scoped twin of downloadUrl.
orgData.selfDeleteArtifact mutation authedProcedure, owner or admin Delete one of the caller's own terminal jobs + its object (org-scoped twin of deleteArtifact, same restore-the-row-on-storage-failure contract).
orgData.selfRestoreRequest mutation rateLimitedOrgProcedure, owner or admin destructive, and deliberately the narrowest of the five: same-org only, own artifact only, never an imported one, slug typed back.

orgBackupConfig#

Source: apps/web/src/server/routers/org-backup-config.ts

Procedure Type Access Description
orgBackupConfig.schedules query superAdminProcedure Super admin — names the org.
orgBackupConfig.scheduleUpsert mutation superAdminProcedure —
orgBackupConfig.scheduleDelete mutation superAdminProcedure —
orgBackupConfig.destinations query superAdminProcedure —
orgBackupConfig.destinationCreate mutation superAdminProcedure —
orgBackupConfig.destinationDelete mutation superAdminProcedure —
orgBackupConfig.destinationTest mutation superAdminProcedure —
orgBackupConfig.selfSchedules query orgProcedure, owner or admin The org's own — cannot name another org.
orgBackupConfig.selfScheduleUpsert mutation rateLimitedOrgProcedure, owner or admin —
orgBackupConfig.selfScheduleDelete mutation rateLimitedOrgProcedure, owner or admin —
orgBackupConfig.selfDestinations query orgProcedure, owner or admin —
orgBackupConfig.selfDestinationCreate mutation rateLimitedOrgProcedure, owner or admin —
orgBackupConfig.selfDestinationDelete mutation rateLimitedOrgProcedure, owner or admin —
orgBackupConfig.selfDestinationTest mutation rateLimitedOrgProcedure, owner or admin —

orgMenu#

Source: apps/web/src/server/routers/org-menu.ts

Procedure Type Access Description
orgMenu.get query authedProcedure One call for the menu editor:
orgMenu.setLabels mutation rateLimitedOrgProcedure —
orgMenu.setOrder mutation rateLimitedOrgProcedure —
orgMenu.setGroupOrder mutation rateLimitedOrgProcedure —
orgMenu.setHiddenItems mutation rateLimitedOrgProcedure —
orgMenu.setGroups mutation rateLimitedOrgProcedure Org-defined nav groups (site/hierarchy design, 2026-09):
orgMenu.resetBrandOverride mutation rateLimitedOrgProcedure Clears a brand's override row back to inheriting the org default, column by column (columns omitted/empty = every column).
orgMenu.setPinnedDashboards mutation rateLimitedOrgProcedure Pin up to 8 saved dashboards into the sidebar.
orgMenu.setCustomNavItems mutation rateLimitedOrgProcedure —

orgBlueprints#

Source: apps/web/src/server/routers/org-blueprints.ts

Read-only listing of every workspace shape an operator may provision for the /admin/orgs create-org form and the org drawer.

Procedure Type Access Description
orgBlueprints.list query superAdminProcedure —

masking#

Source: apps/web/src/server/routers/masking.ts

Procedure Type Access Description
masking.get query orgProcedure, owner or admin Everything the settings screen renders in one read:
masking.aiCandidates query orgProcedure, owner or admin The org's own AI candidates, for the draft's model picker.
masking.updateOrgIdentity mutation rateLimitedOrgProcedure, owner or admin The name and mark an anonymised reader sees in place of the org's own.
masking.saveRoleScope mutation rateLimitedOrgProcedure, owner or admin who reads masked.
masking.upsertTerm mutation rateLimitedOrgProcedure, owner or admin Add a term, or correct one in place.
masking.archiveTerm mutation rateLimitedOrgProcedure, owner or admin Retire a term.
masking.recommend mutation authedProcedure, owner or admin —
masking.acceptSuggestions mutation rateLimitedOrgProcedure, owner or admin the only writer of origin: 'ai_accepted'.
masking.preview query orgProcedure, owner or admin —