Skip to main content

Hierarchy

Every resource - secrets, configs, feature flags - is scoped to a service.

Tenant

A tenant is your top-level organisation. It is the billing boundary: invoices are issued per tenant, and your tier quota applies per project within that tenant.
  • One tenant per company, agency, or individual account
  • Tenant roles: owner and member
  • owner is automatically an owner of every project in the tenant
  • Tenant capabilities granted to members by owners: billing_access (dashboard + billing/invoices), all_projects_viewer (read-only access to every project without explicit membership), audit_log_viewer (tenant-level audit log)

Project

A project represents one product or application. It has:
  • A tier (free / xs / s / m / l / xl) that controls environments, secrets cap, retention window, and add-on availability
  • Its own member list with project-level roles
  • One or more services and a set of allowed environments

Environments

The environments available to a project depend on its tier: Configs, flags and secret keys move from one environment to the next through environment promotion, one step at a time.

Project roles

Which roles can accept an environment promotion into each environment is listed under Accepting a promotion.

Service

A service is a single deployable unit - a backend API, a worker, a frontend app. It belongs to one project and one environment. Every service has an immutable kind:

Backend

Uses secret keys (wxs_). Has access to secrets, configs, and flags. Supports Workload Identity Federation (WIF).

Frontend

Uses public keys (wxp_). Configs and flags only - secrets are never sent to frontend services. Cannot use WIF.

Umbrella services

An umbrella service acts as a shared parent for configs, flags, and (for backend umbrellas) secrets. Child services inherit its values automatically - useful for settings shared across multiple services in the same environment.
  • Umbrella services have no API keys of their own
  • Standard umbrellas (backend or frontend) match child services of the same kind; Cross Umbrellas (shared) can be inherited by both backend and frontend services (configs and flags only, never secrets)
  • The inheritance is flat (no nested umbrellas)

Enabled and disabled environments

An environment can be switched off at the project level without deleting its services or values. While disabled, runtime SDK requests receive HTTP 403 (environment_disabled) and SDKs pause background traffic while serving their last cached snapshot.

Auth paths

API key (classic)

Workload Identity Federation (WIF)

Backend services in Kubernetes, AWS, GCP, or Azure environments can authenticate without static API keys. The SDK fetches an OIDC token from the environment, exchanges it at /v1/auth/token-exchange for a short-lived session JWT, and auto-refreshes before expiry. See the Go SDK WIF guide for setup instructions.

Audit log

Every mutating action - and selected read events (secret reveal, list) - is recorded in the audit log with actor, IP, user agent, and timestamp. The retention window depends on the project tier.