diff --git a/docs/en/images/exist-user-accept.png b/docs/en/images/exist-user-accept.png new file mode 100644 index 0000000000..b2fa367b21 Binary files /dev/null and b/docs/en/images/exist-user-accept.png differ diff --git a/docs/en/images/invite-admin-user-to-join-tenant-modal.png b/docs/en/images/invite-admin-user-to-join-tenant-modal.png new file mode 100644 index 0000000000..4c89da6427 Binary files /dev/null and b/docs/en/images/invite-admin-user-to-join-tenant-modal.png differ diff --git a/docs/en/images/invite-admin-user-to-join-tenant.png b/docs/en/images/invite-admin-user-to-join-tenant.png new file mode 100644 index 0000000000..a847c5d2d6 Binary files /dev/null and b/docs/en/images/invite-admin-user-to-join-tenant.png differ diff --git a/docs/en/images/invite-user.png b/docs/en/images/invite-user.png new file mode 100644 index 0000000000..4422156597 Binary files /dev/null and b/docs/en/images/invite-user.png differ diff --git a/docs/en/images/manage-invitations.png b/docs/en/images/manage-invitations.png new file mode 100644 index 0000000000..6dce784a6e Binary files /dev/null and b/docs/en/images/manage-invitations.png differ diff --git a/docs/en/images/new-user-accept.png b/docs/en/images/new-user-accept.png new file mode 100644 index 0000000000..a2b3644e13 Binary files /dev/null and b/docs/en/images/new-user-accept.png differ diff --git a/docs/en/images/new-user-join-strategy-create-tenant-success.png b/docs/en/images/new-user-join-strategy-create-tenant-success.png new file mode 100644 index 0000000000..2b45e1f9b0 Binary files /dev/null and b/docs/en/images/new-user-join-strategy-create-tenant-success.png differ diff --git a/docs/en/images/new-user-join-strategy-create-tenant.png b/docs/en/images/new-user-join-strategy-create-tenant.png new file mode 100644 index 0000000000..67f68f5ca6 Binary files /dev/null and b/docs/en/images/new-user-join-strategy-create-tenant.png differ diff --git a/docs/en/images/new-user-join-strategy-inform.png b/docs/en/images/new-user-join-strategy-inform.png new file mode 100644 index 0000000000..cb4d9e2983 Binary files /dev/null and b/docs/en/images/new-user-join-strategy-inform.png differ diff --git a/docs/en/images/switch-tenant.png b/docs/en/images/switch-tenant.png new file mode 100644 index 0000000000..f337131ae3 Binary files /dev/null and b/docs/en/images/switch-tenant.png differ diff --git a/docs/en/images/tenant-selection.png b/docs/en/images/tenant-selection.png new file mode 100644 index 0000000000..d328e73eb8 Binary files /dev/null and b/docs/en/images/tenant-selection.png differ diff --git a/docs/en/images/user-accepted.png b/docs/en/images/user-accepted.png new file mode 100644 index 0000000000..a5240aab0c Binary files /dev/null and b/docs/en/images/user-accepted.png differ diff --git a/docs/en/modules/account-pro.md b/docs/en/modules/account-pro.md index 7944c7448a..a79c3d4992 100644 --- a/docs/en/modules/account-pro.md +++ b/docs/en/modules/account-pro.md @@ -425,3 +425,5 @@ This module doesn't define any additional distributed event. See the [standard d * [Session Management](./account/session-management.md) * [Idle Session Timeout](./account/idle-session-timeout.md) * [Web Authentication API (WebAuthn) passkeys](./account/passkey.md) +* [Shared user accounts](./account/shared-user-accounts.md) +``` \ No newline at end of file diff --git a/docs/en/modules/account/shared-user-accounts.md b/docs/en/modules/account/shared-user-accounts.md new file mode 100644 index 0000000000..4df18e2fdf --- /dev/null +++ b/docs/en/modules/account/shared-user-accounts.md @@ -0,0 +1,151 @@ +```json +//[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." +} +``` + +# Shared User Accounts + +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). + +## Introduction + +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. + +## Enabling Shared User Accounts + +Enable shared accounts by configuring `AbpMultiTenancyOptions.UserSharingStrategy`: + +```csharp +Configure(options => +{ + options.IsEnabled = true; + options.UserSharingStrategy = TenantUserSharingStrategy.Shared; +}); +``` + +### Constraints and Behavior + +When you use Shared User Accounts: + +- Username/email uniqueness becomes **global** (Host + all tenants). A username/email can exist only once, but that user can be invited into multiple tenants. +- Some security/user management settings (2FA, lockout, password policies, recaptcha, etc.) are managed at the **Host** level. + +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](#migration-guide) section below. + +## Tenant Selection During Login + +If a user account belongs to multiple tenants, the login flow prompts the user to select the tenant to sign in to: + +![Tenant Selection](../../images/tenant-selection.png) + +## Switching Tenants + +After signing in, the user can switch between the tenants they have joined using the tenant switcher in the user menu: + +![Tenant Switching](../../images/switch-tenant.png) + +## Leaving a Tenant + +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 `UserId` does not change and tenant-related data (roles, permissions, etc.) is preserved. + +## Inviting Users to a Tenant + +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. + +![Invite User](../../images/invite-user.png) + +## Managing Invitations + +From the invitation modal, you can view and manage sent invitations, including resending an invitation email and revoking individual or all invitations. + +![Manage Invitations](../../images/manage-invitations.png) + +## Accepting an Invitation + +If the invited person already has an account, clicking the email link shows a confirmation screen to join the tenant: + +![Accept Invitation](../../images/exist-user-accept.png) + +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: + +![Accept Invitation New User](../../images/new-user-accept.png) + +After accepting the invitation, the user can sign in and switch to that tenant. + +![Accepted Invitation](../../images/user-accepted.png) + +## Inviting an Admin After Tenant Creation + +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. + +![Invite tenant admin user](../../images/invite-admin-user-to-join-tenant.png) + +![Invite tenant admin user](../../images/invite-admin-user-to-join-tenant-modal.png) + +> In the Isolated strategy, tenant creation commonly seeds an `admin` user automatically. With Shared User Accounts, you usually use invitations instead. + +### Registration Strategy for New Users + +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: + +- **CreateTenant**: Automatically creates a tenant for the new user and adds the user to that tenant. +- **Redirect**: Redirects the user to a URL where you can implement custom logic (commonly: a tenant selection/join experience). +- **Inform** (default): Shows an informational message telling the user to contact an administrator to join a tenant. + +> In this state, the user can't proceed into a tenant context until they follow the configured strategy. + +### CreateTenant Strategy + +```csharp +Configure(options => +{ + options.Strategy = AbpIdentityPendingTenantUserStrategy.CreateTenant; +}); +``` + +![new-user--join-strategy-create-tenant](../../images/new-user-join-strategy-create-tenant.png) + +![new-user--join-strategy-create-tenant-success](../../images/new-user-join-strategy-create-tenant-success.png) + +### Redirect Strategy + +```csharp +Configure(options => +{ + options.Strategy = AbpIdentityPendingTenantUserStrategy.Redirect; + options.RedirectUrl = "/your-custom-logic-url"; +}); +``` + +### Inform Strategy + +```csharp +Configure(options => +{ + options.Strategy = AbpIdentityPendingTenantUserStrategy.Inform; +}); +``` + +![new-user--join-strategy-inform](../../images/new-user-join-strategy-inform.png) + +## Migration Guide + +If you plan to migrate an existing multi-tenant application from an isolated strategy to Shared User Accounts, keep the following in mind: + +1. **Uniqueness check**: Before enabling Shared, ensure all existing usernames and emails are unique globally. ABP performs this check when you switch the strategy and reports conflicts. +2. **Tenants with separate databases**: If some tenants use separate databases, you must ensure the Host database contains matching user records in the `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. +