Multi-Tenant Plugin
This plugin sets up multi-tenancy for your application from within your Admin Panel. It does so by adding a tenant field to all specified collections. Your front-end application can then query data by tenant. You must add the Tenants collection so you control what fields are available for each tenant.
Core features
- Adds a
tenantfield to each specified collection - Adds a tenant selector to the admin panel, allowing you to switch between tenants
- Filters list view results by selected tenant
- Filters relationship fields by selected tenant
- Ability to create "global" like collections, 1 doc per tenant
- Automatically assign a tenant to new documents
Installation
Install the plugin using any JavaScript package manager like pnpm, npm, or Yarn:
1
pnpm add @payloadcms/plugin-multi-tenant
Options
The plugin accepts an object with the following properties:
1
type MultiTenantPluginConfig<ConfigTypes = unknown> = {
2
/**
3
* Base path for your application
4
*
5
* https://nextjs.org/docs/app/api-reference/config/next-config-js/basePath
6
*
7
* @default undefined
8
*/
9
basePath?: string
10
/**
11
* After a tenant is deleted, the plugin will attempt to clean up related documents
12
* - removing documents with the tenant ID
13
* - removing the tenant from users
14
*
15
* @default true
16
*/
17
cleanupAfterTenantDelete?: boolean
18
/**
19
* Automatically
20
*/
21
collections: {
22
[key in CollectionSlug]?: {
23
/**
24
* Set to `true` if you want the collection to behave as a global
25
*
26
* @default false
27
*/
28
isGlobal?: boolean
29
/**
30
* Overrides for the tenant field, will override the entire tenantField configuration
31
*/
32
tenantFieldOverrides?: CollectionTenantFieldConfigOverrides
33
/**
34
* Set to `false` if you want to manually apply the baseListFilter
35
* Set to `false` if you want to manually apply the baseFilter
36
*
37
* @default true
38
*/
39
useBaseFilter?: boolean
40
/**
41
* @deprecated Use `useBaseFilter` instead. If both are defined,
42
* `useBaseFilter` will take precedence. This property remains only
43
* for backward compatibility and may be removed in a future version.
44
*
45
* Originally, `baseListFilter` was intended to filter only the List View
46
* in the admin panel. However, base filtering is often required in other areas
47
* such as internal link relationships in the Lexical editor.
48
*
49
* @default true
50
*/
51
useBaseListFilter?: boolean
52
/**
53
* Set to `false` if you want to handle collection access manually without the multi-tenant constraints applied
54
*
55
* @default true
56
*/
57
useTenantAccess?: boolean
58
}
59
}
60
/**
61
* Enables debug mode
62
* - Makes the tenant field visible in the admin UI within applicable collections
63
*
64
* @default false
65
*/
66
debug?: boolean
67
/**
68
* Enables the multi-tenant plugin
69
*
70
* @default true
71
*/
72
enabled?: boolean
73
/**
74
* Localization for the plugin
75
*/
76
i18n?: {
77
translations: {
78
[key in AcceptedLanguages]?: {
79
/**
80
* @default 'You are about to change ownership from <0>{{fromTenant}}</0> to <0>{{toTenant}}</0>'
81
*/
82
'confirm-modal-tenant-switch--body'?: string
83
/**
84
* `tenantLabel` defaults to the value of the `nav-tenantSelector-label` translation
85
*
86
* @default 'Confirm {{tenantLabel}} change'
87
*/
88
'confirm-modal-tenant-switch--heading'?: string
89
/**
90
* @default 'Assigned Tenant'
91
*/
92
'field-assignedTenant-label'?: string
93
/**
94
* @default 'Tenant'
95
*/
96
'nav-tenantSelector-label'?: string
97
}
98
}
99
}
100
/**
101
* Field configuration for the field added to all tenant enabled collections
102
*/
103
tenantField?: RootTenantFieldConfigOverrides
104
/**
105
* Field configuration for the field added to the users collection
106
*
107
* If `includeDefaultField` is `false`, you must include the field on your users collection manually
108
* This is useful if you want to customize the field or place the field in a specific location
109
*/
110
tenantsArrayField?:
111
| {
112
/**
113
* Access configuration for the array field
114
*/
115
arrayFieldAccess?: ArrayField['access']
116
/**
117
* Name of the array field
118
*
119
* @default 'tenants'
120
*/
121
arrayFieldName?: string
122
/**
123
* Name of the tenant field
124
*
125
* @default 'tenant'
126
*/
127
arrayTenantFieldName?: string
128
/**
129
* When `includeDefaultField` is `true`, the field will be added to the users collection automatically
130
*/
131
includeDefaultField?: true
132
/**
133
* Additional fields to include on the tenants array field
134
*/
135
rowFields?: Field[]
136
/**
137
* Access configuration for the tenant field
138
*/
139
tenantFieldAccess?: RelationshipField['access']
140
}
141
| {
142
arrayFieldAccess?: never
143
arrayFieldName?: string
144
arrayTenantFieldName?: string
145
/**
146
* When `includeDefaultField` is `false`, you must include the field on your users collection manually
147
*/
148
includeDefaultField?: false
149
rowFields?: never
150
tenantFieldAccess?: never
151
}
152
/**
153
* Customize tenant selector label
154
*
155
* Either a string or an object where the keys are i18n codes and the values are the string labels
156
*
157
* @deprecated Use `i18n.translations` instead.
158
*/
159
tenantSelectorLabel?:
160
| Partial<{
161
[key in AcceptedLanguages]?: string
162
}>
163
| string
164
/**
165
* The slug for the tenant collection
166
*
167
* @default 'tenants'
168
*/
169
tenantsSlug?: string
170
/**
171
* Function that determines if a user has access to _all_ tenants
172
*
173
* Useful for super-admin type users
174
*/
175
userHasAccessToAllTenants?: (
176
user: ConfigTypes extends { user: unknown }
177
? ConfigTypes['user']
178
: TypedUser,
179
) => boolean
180
/**
181
* Opt out of adding access constraints to the tenants collection
182
*/
183
useTenantsCollectionAccess?: boolean
184
/**
185
* Opt out including the baseListFilter to filter tenants by selected tenant
186
*/
187
useTenantsListFilter?: boolean
188
/**
189
* Opt out including the baseListFilter to filter users by selected tenant
190
*/
191
useUsersTenantFilter?: boolean
192
}
Basic Usage
In the plugins array of your Payload Config, call the plugin with options:
1
import { buildConfig } from 'payload'
2
import { multiTenantPlugin } from '@payloadcms/plugin-multi-tenant'
3
import type { Config } from './payload-types'
4
5
const config = buildConfig({
6
collections: [
7
{
8
slug: 'tenants',
9
admin: {
10
useAsTitle: 'name',
11
},
12
fields: [
13
// remember, you own these fields
14
// these are merely suggestions/examples
15
{
16
name: 'name',
17
type: 'text',
18
required: true,
19
},
20
{
21
name: 'slug',
22
type: 'text',
23
required: true,
24
},
25
{
26
name: 'domain',
27
type: 'text',
28
required: true,
29
},
30
],
31
},
32
],
33
plugins: [
34
multiTenantPlugin<Config>({
35
collections: {
36
pages: {},
37
navigation: {
38
isGlobal: true,
39
},
40
},
41
}),
42
],
43
})
44
45
export default config
Front end usage
The plugin scaffolds out everything you will need to separate data by tenant. You can use the tenant field to filter data from enabled collections in your front-end application.
In your frontend you can query and constrain data by tenant with the following:
1
const pagesBySlug = await payload.find({
2
collection: 'pages',
3
depth: 1,
4
draft: false,
5
limit: 1000,
6
overrideAccess: false,
7
where: {
8
// your constraint would depend on the
9
// fields you added to the tenants collection
10
// here we are assuming a slug field exists
11
// on the tenant collection, like in the example above
12
'tenant.slug': {
13
equals: 'gold',
14
},
15
},
16
})
NextJS rewrites
Using NextJS rewrites and this route structure /[tenantDomain]/[slug], we can rewrite routes specifically for domains requested:
1
async rewrites() {
2
return [
3
{
4
source: '/((?!admin|api)):path*',
5
destination: '/:tenantDomain/:path*',
6
has: [
7
{
8
type: 'host',
9
value: '(?<tenantDomain>.*)',
10
},
11
],
12
},
13
];
14
}
React Hooks
Below are the hooks exported from the plugin that you can import into your own custom components to consume.
useTenantSelection
You can import this like so:
1
import { useTenantSelection } from '@payloadcms/plugin-multi-tenant/client'
2
3
...
4
5
const tenantContext = useTenantSelection()
The hook returns the following context:
1
type ContextType = {
2
/**
3
* Array of options to select from
4
*/
5
options: OptionObject[]
6
/**
7
* The currently selected tenant ID
8
*/
9
selectedTenantID: number | string | undefined
10
/**
11
* Prevents a refresh when the tenant is changed
12
*
13
* If not switching tenants while viewing a "global",
14
* set to true
15
*/
16
setPreventRefreshOnChange: React.Dispatch<React.SetStateAction<boolean>>
17
/**
18
* Sets the selected tenant ID
19
*
20
* @param args.id - The ID of the tenant to select
21
* @param args.refresh - Whether to refresh the page
22
* after changing the tenant
23
*/
24
setTenant: (args: {
25
id: number | string | undefined
26
refresh?: boolean
27
}) => void
28
}
Examples
The Examples Directory also contains an official Multi-Tenant example.
Next