Settings and organizations
Install settings
| Method and path | Who | What it does |
|---|---|---|
GET /branding | anyone, no sign-in | The install's branding, which the sign-in page shows. |
GET /localization | anyone, no sign-in | The console's languages and the install's default. |
GET /settings/install | platform admin | External providers (the Helm ceiling, the console switch and the result), branding and language, as stored. |
PUT /settings/install/external-providers | platform admin | {"enabled": true}, false, or null to follow the Helm value. Turning it on past the Helm ceiling answers 409 and names the value. |
PUT /settings/install/branding | platform admin | {"product_name", "logo", "logo_dark", "primary_color"}. Logos are data: URLs (PNG, SVG, JPEG or WebP, up to 256 KB). The name is up to 40 characters, the colour #RRGGBB. |
PUT /settings/install/localization | platform admin | {"default_locale": "ar"}: en, ar or fr. |
GET /admin/voice-catalog | platform admin | The voices and speech models the install can add. |
POST /admin/voice-catalog/seed | platform admin | Add voices and speech models to the catalog and build them. |
GET /admin/system | platform admin | The System page: version, component health, licence, NetworkPolicy and upgrade facts. |
Organization settings
| Method and path | Who | What it does |
|---|---|---|
GET /tenants/{tenant_id}/settings | organization member | The organization's settings. |
PUT /tenants/{tenant_id}/settings | organization admin or platform admin | The whole document: timezone (an IANA name), guardrail_profile_id, external_providers ("off" keeps the organization's projects in the cluster), allowed_models, and branding. A field left out or null follows the install. |
PATCH /tenants/{tenant_id} | organization admin or platform operator | Rename or describe the organization. |
Organizations in SaaS mode
These routes are for platform operators on an install with tenancy.mode: saas. See Multi-tenancy.
| Method and path | What it does |
|---|---|
GET /platform/tenancy | The tenancy mode, the operator role, and the row-level security state. |
GET /platform/tenants | Every organization. |
POST /platform/tenants | Onboard an organization, with its first admin and a first project. |
POST /platform/tenants/{tenant_id}/suspend | Refuse every member, key and agent of the organization. |
POST /platform/tenants/{tenant_id}/resume | Stop refusing them. |
POST /platform/tenants/{tenant_id}/offboard | {"confirm": "<tenant id>"}. For good: every personal, project and agent key of the organization is revoked. |
DELETE /platform/tenants/{tenant_id}?confirm=<tenant id> | Purge an offboarding organization's rows, then the organization. |
A console user who belongs to several organizations chooses one per request with the X-Vois-Tenant header. The console's organization switcher sends it.
Was this page helpful?