Documentation
Every Veltrix workspace is an organization (a tenant). Everything inside it — users, roles, API keys, canvases, apps, deployments — is isolated to that organization. The organization settings are where you describe the organization itself, and where you reach the people-management screens that live next to it.
This page covers the Organization settings page and day-to-day user administration. Roles, permissions and single sign-on are documented in Access Control & Single Sign-On; API keys are in API Keys & Tokens; plan limits are in Plans, Limits & Trial.
| Screen | Portal location | Route | Permission |
|---|---|---|---|
| Settings index | Sidebar, Govern → Settings | /settings | Signed in |
| Organization | Govern → Settings → Organization | /settings/organization | organization:read to load, organization:write to change |
| Access Control (users, roles, identity provider) | Govern → Settings → Access Control | /access-control | role:read shows the nav entry; user:write to add, edit or delete users |
| Group Admin | Govern → Group Admin (only when granted) | /group-admin | Explicit group-admin grant |
| MSSP console | Govern → MSSP (only for MSSP organizations) | /mssp | MSSP organization |
The old /settings/users and /settings/roles addresses redirect to /access-control, so stale bookmarks keep working.
The Organization page shows the profile read-only. Choose Edit Information to change it, then Save Changes (or Cancel to discard).
| Field | Required | Rules and notes |
|---|---|---|
| Organization Name | Yes | Display name of the organization. New self-service organizations start as “<your name>'s Organization” and can be renamed here. |
| Shortname | No | See Shortname. |
| Website | No | Must start with http:// or https:// (max 2048 characters). Other schemes are rejected. Shown as a link. |
| Phone | No | Free text. |
| Yes (in the form) | Organization contact email. Must be a valid address. | |
| Address, City, State/Province, ZIP/Postal Code, Country | No | Free text. Displayed together as a postal address. |
| Industry | No | Free text. |
| Description | No | Multi-line free text. |
| Logo | No | Choose an image file; a preview appears before you save. Only image content is displayed back. |
Only the fields above are editable by an organization. Tenant identifiers, plan, and platform-level settings cannot be changed from this page.
The shortname is a unique, human-readable identifier for your organization. Veltrix uses it to tag cloud resources it provisions for you, so you can recognise them in your own cloud console. If you leave it blank, your account ID is used instead.
acme-prod).| Action | Needs | Plan |
|---|---|---|
| View the organization profile | organization:read | All plans |
| Edit the profile | organization:write | All plans |
| Convert to MSSP, request to join an MSSP, leave one | organization:write | All plans |
| Add, edit or delete users | user:write | All plans, subject to the user limit below |
| Create or edit custom roles; configure SSO | role:write and a paid plan | Paid plans only |
The tenant Administrator role holds every permission. API calls made with an API key need the key's role to carry the same permissions.
User management is the first tab of Settings → Access Control. The list shows each user's name, email, phone and role, plus an Auth Provider column when your organization has non-local users.
user:write).Use the edit icon in the row. You can change name, phone, role and, for local accounts, set a new password (leave it blank to keep the current one). Email cannot be changed after creation. The eye icon opens the user's detail view.
Use the delete icon and confirm in the dialog. For Cognito-backed users, Veltrix also removes the user from your Cognito pool.
Every new organization is created with two roles:
Custom roles, the permission matrix, per-app permissions and identity-provider setup are on paid plans and are documented in Access Control & Single Sign-On. On the free plan the Role Management and Identity Provider tabs show an upgrade prompt, and the server returns a 403 if those APIs are called directly. Local email and password sign-in works on every plan.
A person who registers at /signup (name, email, password) creates a new organization on the free plan, with themselves as its first Administrator — they do not join an existing organization. Anyone who needs to join an existing organization must be added by that organization's administrator or provisioned through its identity provider. See Profile & Account Security for the sign-in flow.
Below the profile, the Organization page shows MSSP cards that depend on your state. Acting on them needs organization:write.
| Card | When shown | What you can do |
|---|---|---|
| Managed by an MSSP | You are not an MSSP | Search for an MSSP by name and choose Request to join. While a request is pending you can Cancel request. Once approved, the card shows who manages you and offers Leave MSSP; leaving keeps your organization and data unchanged and the MSSP immediately loses access. |
| MSSP | You are not an MSSP and hold organization:write | Convert to MSSP turns your organization into an MSSP provider, creates your first portfolio and unlocks the MSSP console. |
| MSSP (already converted) | You are an MSSP | Shows how many portfolios you manage, with Open MSSP console. |
MSSP providers do not join other MSSPs, so the membership card is hidden for them. Portfolios (tenant groups), join-request approval and the console itself are covered in MSSP Console.
organization:read to load; without it you see a load error rather than an empty form.