Skip to content
intermediate ⏱️ 12 min read

Tenant Management

Create, configure, and manage tenants on the skillSYMS platform, including onboarding requests, suspension, and per-tenant settings.

For: Administrators

Summary

This guide covers how platform administrators manage tenants (Skills Development Providers and employers) on skillSYMS. You’ll learn how to review onboarding requests, create new tenants, configure tenant-level settings and features, and handle the tenant lifecycle including suspension and termination.

Who This Guide Is For

  • Platform administrators (SuperAdmin) provisioning new customers
  • Operations staff handling tenant onboarding requests
  • Support staff troubleshooting tenant configuration

Prerequisites

Before you begin, ensure you have:

  • Platform administrator credentials with tenant management permissions
  • The new tenant’s legal entity details (name, SDL number, contact)
  • The agreed plan or pricing tier for the tenant

Step 1: Review Onboarding Requests

Navigate to Admin → Tenants → Requests.

This screen lists incoming tenant onboarding and plan requests awaiting review. For each request you can:

  • Inspect the submitted organization details
  • Approve and convert the request into a live tenant
  • Reject requests that don’t meet criteria

Tip: Always confirm the SDL/SDP accreditation number before approving — it cannot be silently changed later without an audit entry.

Step 2: Create a New Tenant

Navigate to Admin → Tenants → Add Tenant.

Complete the new tenant form:

  1. Tenant Name: The legal/trading name of the organization
  2. SDL Number: The skills development levy number
  3. Instance Code: The short code used for the tenant’s environment
  4. Primary Contact: Name and email of the tenant owner
  5. Plan: The subscription plan to assign

Submitting the form provisions the tenant and creates the initial owner record.

Step 3: Configure Tenant Settings

Navigate to Admin → Tenants, then open a tenant to reach its detail page.

From the tenant detail screen you can manage:

  • Branding — upload logos and set tenant colours
  • Features — toggle which platform modules the tenant can access
  • Instance code — the tenant’s environment identifier
  • Allowed hostnames / domains — custom domains the tenant may use
  • Health — review the tenant’s operational status

Tip: Feature toggles take effect immediately. Coordinate with the tenant before enabling or disabling a module they rely on.

Step 4: Manage Custom Domains

On the tenant detail page, open the Domains section to add or remove custom hostnames.

  1. Click Add Domain
  2. Enter the fully-qualified hostname
  3. Save, then complete any DNS verification the tenant is asked to perform

Removing a domain immediately stops it resolving to the tenant.

Step 5: Suspend, Unsuspend, or Terminate

From the tenant detail page you can manage the tenant lifecycle:

  • Suspend — temporarily block access (e.g. for non-payment)
  • Unsuspend — restore a suspended tenant
  • Rotate Key — issue a fresh API key for the tenant
  • Terminate — permanently decommission the tenant

Tip: Suspension is reversible; termination is not. Export any required compliance data before terminating.

Step 6: Review the Tenant Audit Trail

Open the Audit tab on the tenant detail page to see a chronological record of administrative actions taken against the tenant. Use this when investigating support tickets or compliance queries.

Common Mistakes to Avoid

  1. Approving without verifying accreditation: Always check the SDL/SDP number against official records first
  2. Disabling features on active tenants: Toggling off a module mid-use can break learner workflows
  3. Terminating instead of suspending: Termination is permanent — use suspend for temporary blocks
  4. Forgetting domain DNS verification: Custom domains won’t work until the tenant completes DNS setup

Verification Checklist

Before considering a tenant live, verify:

  • Onboarding request reviewed and approved
  • Tenant created with correct SDL number and instance code
  • Plan assigned
  • Required features enabled
  • Branding and any custom domains configured
  • Owner can log in successfully

Next Steps