Multi-tenant Configuration for Admin API 2.x

MultiTenancy can be enabled in the appsettings file by updating “MultiTenancy” flag to true.

"AppSettings": {
     
	“MultiTenancy”: true
}

Connection Strings

The connection strings for the EdFi_Admin and EdFi_Security databases are configured differently depending on whether the MultiTenancy feature is enabled or disabled.

Single-Tenant Configuration (the default)

In a single-tenant configuration, there is only one EdFi_Admin and EdFi_Security used by Admin API.

The connection strings are in the "ConnectionStrings" section, as follows:

"ConnectionStrings": {
    "EdFi_Admin": "Server=(local); Database=EdFi_Admin; Integrated Security=True; Application Name=AdminApi;",
    "EdFi_Security": "Server=(local); Database=EdFi_Security; Integrated Security=True; Application Name=AdminApi;"
}

Multi-Tenant Configuration

In a multi-tenant configuration, each tenant has its own EdFi_Admin and EdFi_Security databases.

The connection strings are organized under distinct tenant entries in a "Tenants" section, as follows:

"Tenants": {
    "Tenant1": {
      "ConnectionStrings": {
        "EdFi_Admin": "Server=(local); Database=EdFi_Admin_Tenant1; Integrated Security=True; Application Name=AdminApi;",
        "EdFi_Security": "Server=(local); Database=EdFi_Security_Tenant1; Integrated Security=True; Application Name=AdminApi;"
      }
    },
    "Tenant2": {
      "ConnectionStrings": {
        "EdFi_Admin": "Server=(local); Database=EdFi_Admin_Tenant2; Integrated Security=True; Application Name=AdminApi;",
        "EdFi_Security": "Server=(local); Database=EdFi_Security_Tenant2; Integrated Security=True; Application Name=AdminApi;"
      }
    }
  }

Request header

Admin API clients must use request header to carry the well-known tenant identifier.

Tenant specific request header key: tenant

Tenant specific request header value: <Tenant-Id>

Note: The requests from Swagger UI don’t automatically include tenant identifier in the headers. So, if user enables Swagger UI and MultiTenancy,

then “DefaultTenant” should be configured as follows in the appSettings file:

"SwaggerSettings": {
        "EnableSwagger": true,
        "DefaultTenant": "Tenant1"
    }

So, all the requests from Swagger UI will be using “DefaultTenant” as tenant identifier.