# Admin console

> The admin console is OpenSteward's web UI for the people who run it. It is the admin service on port 3000 (http://localhost:3000 in the Docker quick start). Every action goes…

> [← Documentation](https://docs.opensteward.dev/overview/)



The admin console is OpenSteward's web UI for the people who run it. It is the
`admin` service on port 3000 (`http://localhost:3000` in the Docker quick
start). Every action goes through admin-api, which checks your role and
permissions again on each call, so the console only shows what you are allowed
to do.

Use it to:

- set up platforms;
- send Connect Links to customers;
- watch connections and syncs;
- browse synced records;
- build dashboards;
- manage who can do what.

This guide goes through the console page by page. For a route-by-route map
with access levels, see
[architecture/admin-page-map.md](https://docs.opensteward.dev/architecture/admin-page-map/).

![The Status page, the console's home](https://raw.githubusercontent.com/open-steward/opensteward/a3961d894f12b2203f1e4ba79602d95c190d68fd/docs/assets/screenshots/admin/status.png)

## Signing in

- **First run.** On a fresh deployment every page redirects to `/setup/init`.
  Create the first admin account there with a username and password. If the
  deployment sets `BOOTSTRAP_TOKEN`, the form also asks for that token, so
  nobody else can claim a published deployment before you do. Then sign in,
  and the [setup wizard](https://docs.opensteward.dev/admin/setup-wizard/) walks you through the rest.
- **Password.** `/login` takes a username and password.
- **SSO and LDAP.** Once an admin adds an identity provider, the login page
  shows **Sign in with &lt;provider&gt;** for each OIDC or SAML provider, and
  an expandable username and password form for each LDAP directory. If an
  admin turns password login off in **Settings**, the password form moves
  under **Use a local account** for the break-glass admin. See
  [SSO & identity](https://docs.opensteward.dev/admin/sso/).

## The sidebar

The sidebar has three groups. Entries you can't use are hidden.

| Group | Entries |
|---|---|
| **Overview** | [Status](https://docs.opensteward.dev/admin/status/) · [Dashboards](https://docs.opensteward.dev/admin/dashboards/) · [Connections](https://docs.opensteward.dev/admin/connections/) · [Data](https://docs.opensteward.dev/admin/data/) |
| **Connect** | [Connect links](https://docs.opensteward.dev/admin/connect-links/) · [Link templates](https://docs.opensteward.dev/admin/connect-links/#link-templates) · [Customers](https://docs.opensteward.dev/admin/customers/) · [Sync jobs](https://docs.opensteward.dev/admin/sync-jobs/) |
| **Admin** | [Setup wizard](https://docs.opensteward.dev/admin/setup-wizard/) · [Platforms](https://docs.opensteward.dev/admin/platforms/) · [Scope groups](https://docs.opensteward.dev/admin/platforms/#scope-groups) · [Tenants & domains](https://docs.opensteward.dev/admin/tenants-company-and-settings/#tenants-and-domains) · [Users](https://docs.opensteward.dev/admin/users-and-roles/) · [Roles](https://docs.opensteward.dev/admin/users-and-roles/#roles) · [Destinations](https://docs.opensteward.dev/admin/destinations/) · [SQL access](https://docs.opensteward.dev/admin/sql-access-and-superset/) · [SSO & identity](https://docs.opensteward.dev/admin/sso/) · [API keys](https://docs.opensteward.dev/admin/api-keys-oauth-and-webhooks/) · [OAuth clients](https://docs.opensteward.dev/admin/api-keys-oauth-and-webhooks/#oauth-clients) · [Webhooks](https://docs.opensteward.dev/admin/api-keys-oauth-and-webhooks/#webhooks) · [Audit log](https://docs.opensteward.dev/admin/audit-and-profile/) · [Company](https://docs.opensteward.dev/admin/tenants-company-and-settings/#company) · [Settings](https://docs.opensteward.dev/admin/tenants-company-and-settings/#settings) · [System](https://docs.opensteward.dev/admin/tenants-company-and-settings/#system) |

The header across the top holds:

- your picture and username, which link to [My profile](https://docs.opensteward.dev/admin/audit-and-profile/#my-profile);
- your role, plus a **scoped** badge if you only see some tenants;
- the **notifications bell**, with an unread count, which opens
  [Notifications](https://docs.opensteward.dev/admin/tenants-company-and-settings/#notifications);
- the light/dark theme toggle;
- **Log out**.

The sidebar footer shows the build each service is running. The brand link at
the top shows your company logo once one is set under **Company**.

## Who sees what

Every console user has a **role**. There are three built-in roles:

- **viewer** looks.
- **operator** runs the day-to-day work.
- **admin** configures the deployment.

An admin can also define **custom roles**. Each custom role has a base role
and its own set of permissions (see [Users, roles and tenant scope](https://docs.opensteward.dev/admin/users-and-roles/)).
Some pages check the base role and others check a single permission.

| Page | viewer | operator | admin | Decided by |
|---|---|---|---|---|
| [Status](https://docs.opensteward.dev/admin/status/) | View | Also clears connection and sync rows under **Needs attention** (not when restricted to some tenants) | Also sees the setup card and acts on platform and vertical rows | Any signed-in user |
| [Dashboards](https://docs.opensteward.dev/admin/dashboards/) | View | Also creates and edits dashboards | Also shares with everyone and decides who sees Superset dashboards | `dashboards:view`, `dashboards:edit`, `dashboards:share_all` |
| [Connections](https://docs.opensteward.dev/admin/connections/) | View | Also renames, syncs, sets the sync schedule and deletes | Same as operator | Any signed-in user. Changes need the operator role |
| [Data](https://docs.opensteward.dev/admin/data/) | — | Browses masked records and exports them | Also reveals personal data | `data:read`, `data:export`, `data:read_pii` |
| [Connect links, templates](https://docs.opensteward.dev/admin/connect-links/), [Customers](https://docs.opensteward.dev/admin/customers/) | View | Also creates, edits and revokes, and mints customer MCP tokens | Also reveals a customer's personal data and deletes customers | Any signed-in user. Changes need the operator role |
| [Sync jobs](https://docs.opensteward.dev/admin/sync-jobs/) | View | Also cancels jobs | Same as operator | Any signed-in user. Cancel needs the operator role |
| [Notifications](https://docs.opensteward.dev/admin/tenants-company-and-settings/#notifications) | Read | Also dismisses | Also dismisses | Any signed-in user |
| [My profile](https://docs.opensteward.dev/admin/audit-and-profile/#my-profile) | Own picture | Own picture | Own picture | Any signed-in user |
| [Roles](https://docs.opensteward.dev/admin/users-and-roles/#roles) | — | — | Yes | `roles:manage` |
| [Destinations](https://docs.opensteward.dev/admin/destinations/) | — | — | Yes | `destinations:manage` |
| [SQL access](https://docs.opensteward.dev/admin/sql-access-and-superset/) | — | — | Yes | `sql_access:manage` |
| Setup wizard, Platforms, Scope groups, Tenants & domains, Users, SSO & identity, API keys, OAuth clients, Webhooks, Audit log, Company, Settings, System | — | Some by URL (below) | Yes | The admin base role |

Some things the table doesn't show:

- **The Admin group** appears for admins, and for anyone holding
  `roles:manage`, `destinations:manage` or `sql_access:manage`. They see only
  those entries.
- **Operators can open some admin pages by typing the URL.** `/api-keys`,
  `/webhooks` and `/oauth-clients` are read-only for them. On `/tenants` they
  can also create and delete tenants, and on `/scope-groups` create and edit
  scope groups. Viewers can open `/tenants`, `/scope-groups` and
  `/setup/wizard` read-only.
- **Tenant scope narrows what a user sees.** A user restricted to some tenants
  sees only those tenants' connections, sync jobs, records and dashboard
  numbers.
  - Pages that aren't tenant-scoped yet refuse them: customers, Connect Links,
    link templates, API keys, webhooks, OAuth clients and the audit log.
  - So do deployment-wide changes, such as platform configuration and scope
    groups.
  - An admin always sees every tenant.
- **Hidden doesn't mean unprotected.** The console hides what you can't use,
  but admin-api makes the real decision on every request.

The full permission catalog and the escalation guards are in
[architecture/permissions-and-roles.md](https://docs.opensteward.dev/architecture/permissions-and-roles/).

## Pages in this guide

In reading order:

1. [Setup wizard](https://docs.opensteward.dev/admin/setup-wizard/): the eight first-run steps.
2. [Status](https://docs.opensteward.dev/admin/status/): health and the **Needs attention** list.
3. [Dashboards](https://docs.opensteward.dev/admin/dashboards/): built-in and custom charts over synced data,
   plus embedded Superset.
4. [Connections](https://docs.opensteward.dev/admin/connections/): every authorized platform account, and its
   sync schedule.
5. [Data](https://docs.opensteward.dev/admin/data/): browse, reveal and export synced records.
6. [Connect links and templates](https://docs.opensteward.dev/admin/connect-links/): send customers a link
   to connect a platform.
7. [Customers](https://docs.opensteward.dev/admin/customers/): the end-customers behind your connections, and
   their MCP tokens.
8. [Sync jobs](https://docs.opensteward.dev/admin/sync-jobs/): what synced, when, why and how far it got.
9. [Platforms and scope groups](https://docs.opensteward.dev/admin/platforms/): the adapter catalog, OAuth
   credentials and scope bundles.
10. [Users, roles and tenant scope](https://docs.opensteward.dev/admin/users-and-roles/): console accounts and
    what they may do and see.
11. [SSO & identity](https://docs.opensteward.dev/admin/sso/): OIDC, SAML and LDAP sign-in, role and scope
    mapping, and SCIM.
12. [Destinations](https://docs.opensteward.dev/admin/destinations/): scheduled exports to your lake or
    warehouse.
13. [SQL access and Superset](https://docs.opensteward.dev/admin/sql-access-and-superset/): read-only Postgres
    logins for BI tools, and embedded Superset.
14. [API keys, OAuth clients and webhooks](https://docs.opensteward.dev/admin/api-keys-oauth-and-webhooks/):
    the developer API's credentials and outbound events.
15. [Tenants, company, settings and notifications](https://docs.opensteward.dev/admin/tenants-company-and-settings/):
    deployment-wide configuration.
16. [Audit log and My profile](https://docs.opensteward.dev/admin/audit-and-profile/).

## Related docs

- [Architecture: admin page map](https://docs.opensteward.dev/architecture/admin-page-map/): every
  route, grouped by access level.
- [Architecture: permissions, roles and tenant scope](https://docs.opensteward.dev/architecture/permissions-and-roles/).
- [Architecture: auth and tenancy](https://docs.opensteward.dev/architecture/auth-and-tenancy/): the
  five-layer auth model and first-run bootstrap.
- [Developer Guide](https://docs.opensteward.dev/dev-api/): the API your applications call.
