docs/en/modules/account/shared-user-accounts.md
//[doc-seo]
{
"Description": "Learn how Shared User Accounts work in ABP (UserSharingStrategy): login flow with tenant selection, switching tenants, inviting users, and the Pending Tenant registration flow."
}
This document explains Shared User Accounts: a single user account can belong to multiple tenants, and the user can choose/switch the active tenant when signing in.
This is a commercial feature. It is mainly provided by Account.Pro and Identity.Pro (and related SaaS UI).
In a typical multi-tenant setup with the Isolated user strategy, a user belongs to exactly one tenant (or the Host), and uniqueness rules (username/email) are usually scoped per tenant.
If you want a one account, multiple tenants experience (for example, inviting the same email address into multiple tenants), you should enable the Shared user strategy.
Enable shared accounts by configuring AbpMultiTenancyOptions.UserSharingStrategy:
Configure<AbpMultiTenancyOptions>(options =>
{
options.IsEnabled = true;
options.UserSharingStrategy = TenantUserSharingStrategy.Shared;
});
When you use Shared User Accounts:
If you are migrating from an isolated strategy, ABP will validate the existing data when you switch to Shared. If there are conflicts (e.g., the same email registered as separate users in different tenants), you must resolve them before enabling the shared strategy. See the Migration Guide section below.
If a user account belongs to multiple tenants, the login flow prompts the user to select the tenant to sign in to:
After signing in, the user can switch between the tenants they have joined using the tenant switcher in the user menu:
Users can leave a tenant. After leaving, the user is no longer a member of that tenant, and the tenant can invite the user again later.
When a user leaves and later re-joins the same tenant, the
UserIddoes not change and tenant-related data (roles, permissions, etc.) is preserved.
Tenant administrators can invite existing or not-yet-registered users to join a tenant. The invited user receives an email; clicking the link completes the join process. If the user doesn't have an account yet, they can register and join through the same flow.
While inviting, you can also assign roles so the user gets the relevant permissions automatically after joining.
The invitation feature is also available in the Isolated strategy, but invited users can join only a single tenant.
From the invitation modal, you can view and manage sent invitations, including resending an invitation email and revoking individual or all invitations.
If the invited person already has an account, clicking the email link shows a confirmation screen to join the tenant:
If the invited person doesn't have an account yet, clicking the email link takes them to registration and then joins them to the tenant:
After accepting the invitation, the user can sign in and switch to that tenant.
With Shared User Accounts, you typically don't create an admin user during tenant creation. Instead, create the tenant first, then invite an existing user (or a new user) and grant the required roles.
In the Isolated strategy, tenant creation commonly seeds an
adminuser automatically. With Shared User Accounts, you usually use invitations instead.
When a user registers a new account, the user is not a member of any tenant by default (and is not a Host user). You can configure AbpIdentityPendingTenantUserOptions.Strategy to decide what happens next.
Available strategies:
In this state, the user can't proceed into a tenant context until they follow the configured strategy.
Configure<AbpIdentityPendingTenantUserOptions>(options =>
{
options.Strategy = AbpIdentityPendingTenantUserStrategy.CreateTenant;
});
Configure<AbpIdentityPendingTenantUserOptions>(options =>
{
options.Strategy = AbpIdentityPendingTenantUserStrategy.Redirect;
options.RedirectUrl = "/your-custom-logic-url";
});
Configure<AbpIdentityPendingTenantUserOptions>(options =>
{
options.Strategy = AbpIdentityPendingTenantUserStrategy.Inform;
});
If you plan to migrate an existing multi-tenant application from an isolated strategy to Shared User Accounts, keep the following in mind:
AbpUsers table (and, if you use social login / passkeys, also sync AbpUserLogins and AbpUserPasskeys) so the Host-side records match the tenant-side data. After that, the framework can create/manage the user-to-tenant associations.