feat(multi-tenant): Add option to pass a filter function for tenants array

[simovicaleksa]

Add option to pass a filter function to the tenants array/select. My use case for this would be so superadmin users can only edit specific tenants on their respective domains.

So for example in application with 3 tenants (e.g. A, B and C):

Domain	Has Access To
a.example.com	A
b.example.com	B
admin.example.com	A, B, C

Of course this is just one use case that I've came up with, but theoretically you could come up with as many, or as few custom rules as you'd like.

Example of such configuration in payload.config.ts would look something like this:

// payload.config.ts
plugins: [
    multiTenantPlugin({
      collections: {
        // ...
      },
      userHasAccessToAllTenants: (user) => isSuperAdmin(user),
      filterTenants: async ({req, tenants}) => {
        const hostDomain = await getHostDomain(req);
        if (hostDomain === "admin.example.com") return tenants;

        const filteredTenants = [tenants.find((tenant) => tenant.domain === hostDomain)]

        return filteredTenants;
      }
    }),
  // ...
]

As far as I can see the only way to implement something like this would be to create a custom component for the tenant selection which is far from ideal.

[AdrianMaj]

I'd also like to see this feature implemented, as it would enable role-based tenant selection. For example, if you're a member of one tenant and an admin of two other tenants, you would only see the 2 tenants you're administrating in the selector.

[DallasO]

Couldn't this be handled by returning a filter query in the read access control?
I haven't used the plugin, but looks like this is accessed here in the plugin config: accessResultOverride

[AdrianMaj]

Unfortunately not, I've did this at first but even that in the tenants collection I am unable to read filtered tenants (which is correct) they still appear in the selector.

accessResultOverride is used for tenant collections, but not for "tenants" collection itself, so it won't help either.

[AdrianMaj]

Hey @simovicaleksa this is being resolved here: #14620

Feel free to follow the PR for updates!