You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: astro/src/content/docs/get-started/core-concepts/applications.mdx
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,24 +47,27 @@ Below is a visual reminder of the relationships between FusionAuth's primary cor
47
47
<imgsrc="/img/docs/get-started/core-concepts/core-concepts-relationships-applications.png"alt="Diagram showing Applications used within FusionAuth" />
48
48
49
49
## Universal Applications
50
-
A typical FusionAuth application is tied to a single tenant, which works well if you want to expose that application to only the users in a single tenant.
50
+
A universal application is an application that exists for all tenants, rather than belonging to a single tenant. Universal applications are useful when you need to make the same application available to users across many or all tenants.
51
51
52
-
In cases where you want to expose the same application to users in more than one tenant, a universal application is often a better solution. A universal application is tied to all tenants, and uses the same application configuration across all tenants, including its client Id, client credentials, and more. This makes configuration management simpler, allowing you to share configuration across all uses of the application.
52
+
A universal application uses the same application configuration across all tenants, including its client Id, client credentials, and more. This makes configuration management simpler, allowing you to share configuration across all uses of the application.
53
53
54
54
### Universal Application Registrations
55
55
Users from any tenant can have a registration to a universal application, and registrations work as they would for normal applications.
56
56
57
57
### Universal Applications and Tenants
58
-
Becuase a universal application does not belong to a single tenant, when interacting with a universal application, such as during an OAuth authentication workflow, a tenantId will have to be supplied. This tells FusionAuth which tenant to look up a user in, and to retrieve other information from.
58
+
Becuase a universal application does not belong to a single tenant, you will generally have to supply a tenant Id when interacting with a universal application. This is true during authentication and other user-specific workflows. The supplied tenant Id tells FusionAuth which tenant to look a user up in, to retrieve theme information from, and more.
59
59
60
60
The tenant Id is typically provided on a `tenantId` query parameter, unless otherwise specified.
61
61
62
-
A universal application will "inherit" settings from the tenant it is being associated with at runtime. This means that you can customize the behavior of a universal application, per tenant, by using different configuration per tenant.
62
+
A universal application "inherits" settings from the tenant it is being associated with at runtime. This means that you can customize the behavior of a universal application per tenant by using different tenant configuration.
63
63
64
64
Note that for tenant configuration settings that can be overridden at the application level, if you supply an application-level override, that setting will be used for all tenants. If this is not what you want, do not set a value in the universal application's configuration and let the application fall back to what is defined in the tenant.
65
65
66
66
### Universal Applications and Tenant-scoped API Keys
67
-
A tenant-scoped API key is prevented from making changes that could be seen or otherwise affect other tenants than the one it is scoped to. Because universal applications span all tenants, you cannot use a tenant-scoped API key with a universal application via the [Application API](/docs/apis/applications). You can, however, use a tenant-scoped API key to interact with things like registrations and refresh tokens, as these are confined to a user within a tenant.
67
+
A tenant-scoped API key cannot make changes that could be seen or otherwise affect other tenants than the one it is scoped to. Because universal applications span all tenants, you cannot use a tenant-scoped API key with a universal application via the [Application API](/docs/apis/applications). You can, however, use a tenant-scoped API key to interact with things like registrations and refresh tokens, as these are confined to a user within a tenant.
68
+
69
+
### Configure an Application as Universal
70
+
You can only set an application as universal when it is created. Do this by setting `application.universalConfiguration.universal` to `true` when using the API, or select the `Universal` toggle on the Add Application view in the admin app.
Copy file name to clipboardExpand all lines: astro/src/content/docs/lifecycle/manage-users/tenant-manager/index.mdx
+28-20Lines changed: 28 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,32 +25,49 @@ Available since 1.58.0
25
25
</Aside>
26
26
27
27
## Overview
28
-
The Tenant Manager application is an app delivered with FusionAuth that is used for managing users within a FusionAuth tenant. The core FusionAuth application provides Tenant Manager and User Manager roles, however these roles allow for the management of _all_ tenants and users, and access cannot be restricted to a _single_tenant. The Tenant Manager app restricts access to a single tenant.
28
+
The Tenant Manager application is used for managing users within a single FusionAuth tenant. While the app can be used with any setup, it is designed for a setup where each of your customers is assigned to a tenant. Using the Tenant Manager app, your customers can self-manage their own users.
29
29
30
-
While this app can be used with any setup, the Tenant Manager app is perhaps most useful in a B2B context where you have customers mapped to tenants. In this case, the app makes it easy for a customer to have one or more administrative users that can manage other user accounts within their organization, but not see users from any other tenants.
30
+
Note that the core FusionAuth application provides roles for managing tenants and users, however these grant access to _all_tenants and users. The Tenant Manager app restricts access to just the logged-in user's tenant, preventing a user from seeing users from other tenants.
31
31
32
-
## Granting Users Access to the Tenant Manager App
33
-
The Tenant Manager app is a standard application, delivered with FusionAuth. It is a Universal Application, so it is available in any tenant. To grant a user access to it, you only need to register the user to the Tenant Manager application.
32
+
## Accessing Tenant Manager
34
33
35
-
Find the user in the <Breadcrumb>Users</Breadcrumb> area, select <InlineUIElement>Manage</InlineUIElement> from the <InlineUIElement>Action</InlineUIElement> menu, and add the Tenant Manager application on the `Registrations` tab.
34
+
### Granting Users Access to Tenant Manager
35
+
The Tenant Manager app ships with FusionAuth, and is available in all tenants. Register a user to the Tenant Manager app to allow them to use it.
36
+
1. Find the user in the <Breadcrumb>Users</Breadcrumb> area
37
+
2. Select <InlineUIElement>Manage</InlineUIElement> from the <InlineUIElement>Action</InlineUIElement> menu
38
+
3. Add the Tenant Manager application on the `Registrations` tab.
36
39
37
-
The Tenant Manager app has one available role, `admin`. Assigning a user this role will give them full user administration privileges. If you do not assign a role in the user's registration, the user will be granted read-only access.
40
+
The Tenant Manager app has one available role, `admin`. Assigning a user this role gives them full user administration privileges. A user without the `admin` role has read-only access.
38
41
39
42
Note that self-service registration is not available for the Tenant Manager app.
40
43
44
+
## Accessing the Tenant Manager App
45
+
The Tenant Manager app is hosted on your FusionAuth instance at
46
+
47
+
`/tenant-manager/MANAGED_TENANT_ID`
48
+
49
+
Because the Tenant Manager app is a universal application, a tenant Id must be specified so that it knows which tenant to operate on.
50
+
51
+
The Tenant Manager app participates in SSO, just as any other application. This means that if SSO is enabled, a user that is logged into any application in the tenant can SSO into the Tenant Manager app and vice versa. This makes linking to the Tenant Manager app from another application, such as your own SaaS app, seamless to a user.
The Users view shows you a list of users, limited to those from the logged-in user's tenant. The view is paginated, showing pages of 25 users, and you can use the various page buttons to navigate between pages.
58
+
The Users view displays a list of users from the same tenant as the logged-in user. The view is paginated, showing 25 users at one time. Navigation buttons enable moving between pages of users.
47
59
48
-
Using the `Columns` button, you can select which user data columns are shown in the users list. This setting is persistent in your browser, and the app will remember your selection across sessions.
60
+
Configure the data columns shown in the Users view using the Columns button. The chosen setting persists across sessions in the same browser.
49
61
50
62
### Creating Users
51
-
From the Users view, clicking the`Create` button will take you to the New User view, where you can create a user account.
63
+
To create a user, navigate to the Users view and click`Create`. Enter the new user account details on the New User view that opens.
52
64
53
-
The `Basic information` section contains a form for setting user properties. To customize this form you'll need to go to <Breadcrumb>Customizations > Forms</Breadcrumb> in the FusionAuth Admin application and create a new `Admin Registration` form. Then to assign the new form, select your new form in the <Breadcrumb>Application > Edit > Registration > Admin Registration</Breadcrumb> setting for the Tenant Managerapplication, which is found in the <Breadcrumb>Applications</Breadcrumb> area.
65
+
The `Basic information` section contains a form for setting user properties. To customize the properties in the Basic information section:
66
+
* Open the FusionAuth Admin application
67
+
* Open <Breadcrumb>Customizations > Forms</Breadcrumb>
68
+
* Create a new `Admin Registration` form
69
+
* Open the `Tenant manager` application
70
+
* Select your new form in the <Breadcrumb>Registration > Admin Registration</Breadcrumb> setting
54
71
55
72
### Editing Users
56
73
From the Users view, clicking on a user takes you to the Edit User view. From here, you can edit the user's information, change their avatar, or take actions against their account.
@@ -90,12 +107,3 @@ You can assign roles to a user by managing their registration to the Tenant Mana
90
107
91
108
## Customization
92
109
At this time, the Tenant Manager app is not themable.
93
-
94
-
## Accessing the Tenant Manager App
95
-
The Tenant Manager app is hosted on your FusionAuth instance at
96
-
97
-
`/tenant-manager/MANAGED_TENANT_ID`
98
-
99
-
Because the Tenant Manager app is a universal application, a tenant Id must be specified so that it knows which tenant to operate on.
100
-
101
-
The Tenant Manager app participates in SSO, just as any other application. This means that if SSO is enabled, a user that is logged into any application in the tenant can SSO into the Tenant Manager app and vice versa. This makes linking to the Tenant Manager app from another application, such as your own SaaS app, seamless to a user.
0 commit comments