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: content/docs/guides/(authentication)/how-to-guides/login-interface.mdx
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,13 @@ title: "Customize your login interface"
3
3
slug: "login-interface"
4
4
excerpt: ""
5
5
hidden: false
6
-
metadata:
7
-
image: []
8
-
robots: "index"
6
+
metadata:
7
+
image: []
8
+
robots: "index"
9
9
createdAt: "Thu Aug 03 2023 22:56:11 GMT+0000 (Coordinated Universal Time)"
10
10
updatedAt: "Fri Aug 25 2023 21:43:36 GMT+0000 (Coordinated Universal Time)"
11
11
---
12
+
12
13
You can customize your login UI in the Login Experience card of the Application Settings Page. This is reached by selecting the Application in the Authentication page. You can preview your changes before you push them to live in the screen preview on the right-hand side.
13
14
14
15
## Page order
@@ -17,7 +18,7 @@ To show your social sign on buttons above the email input, select “Social firs
17
18
18
19
## Logo and colors
19
20
20
-
You can add your logo and brand colors in the Login Experience card. We recommend using a square, transparent png file up to XxX pixels. The colors section allows you to configure your button fill, text and border, as well as the background color of your login screen.
21
+
You can add your logo and brand colors in the Login Experience card. We recommend using a square, transparent png file. The colors section allows you to configure your button fill, text and border, as well as the background color of your login screen.
21
22
22
23
## Login and sign-up page copy
23
24
@@ -29,6 +30,6 @@ You can customize the Header, Subheading and Footer copy of the login and signup
29
30
30
31
The text input for the footer is HTML-enabled, to allow linking out to pages like your Terms of Service or Privacy Policy pages. However, the only accepted HTML elements are:
31
32
32
-
-**Paragraphs**: `<p>``</p>`
33
-
-**Hyperlinks**: `<a>``</a>` with the `href` attribute
34
-
-**Line breaks**: `<br>``</br>`
33
+
-**Paragraphs**: `<p>``</p>`
34
+
-**Hyperlinks**: `<a>``</a>` with the `href` attribute
This article details how to use UserClouds to migrate off Auth0 in a few easy steps. It will show you how to migrate 100% of your usernames, profiles, passwords and other login factors off Auth0, without forcing any password resets.
10
12
11
13
The process should take around 15 minutes to set up. You may then have to wait a few weeks for Auth0 to comply with your ticket request (see step 6). During this time, user profile data will be migrated over in bulk. Users will log in through UserClouds, with UserClouds using Auth0 as an identity provider. When users successfully log in, their credentials will be stored in the UserClouds User Store. As such, the two databases will converge for active users. After a few weeks, Auth0 will provide a static export of your hashed passwords for inactive users, which you can then upload to UserClouds. At this point, you will have successfully migrated all of your user data off Auth0.
12
14
13
15
The article assumes you have already set up an account, organization, tenant and application in UserClouds. See here for more info.
14
16
15
-
## 1. Ready your Auth0 account
16
-
17
-
### 1a. Create an M2M application in Auth0
18
-
19
-
First, you need to create an M2M application in Auth0, so that UserClouds's server can call the Auth0 server:
20
-
21
-
- Log into Auth0 & click Applications in the sidebar
22
-
- Click Create Application.
23
-
- Call your application something like UserClouds Management App
24
-
- Select M2M and hit Create
25
-
- You will be prompted to define permissions. For development purposes, select All and click Authorize. You will be able to narrow this feature set down later - the permissions you allow will depend on the UC feature set that you use.
26
17
27
-
### 1b. Allow Password Grant Flow
18
+
## Ready your Auth0 account
19
+
<Steps>
20
+
<Step>
21
+
### Create an M2M application in Auth0
28
22
29
-
Next, you need to allow the password grant flow in Auth0. This will let UserClouds capture passwords directly from your end users and verify those passwords with Auth0, rather than redirecting the users themselves to Auth0. This is required to capture any authentication changes for your active users, like new account creations and password resets.
23
+
First, you need to create an M2M application in Auth0, so that UserClouds's server can call the Auth0 server:
30
24
31
-
- In Auth0, navigate to your new M2M app’s settings page
32
-
- Click the Settings sub-tab, scroll to the Advanced Settings card and click the Grant Types tab
33
-
- Enable the Password Grant Flow and click Save
25
+
- Log into Auth0 & click Applications in the sidebar
26
+
- Click Create Application.
27
+
- Call your application something like UserClouds Management App
28
+
- Select M2M and hit Create
34
29
35
-
### 1c. Configure API Authorization in Auth0
30
+
- You will be prompted to define permissions. For development purposes, select All and click Authorize. You will be able to narrow this feature set down later - the permissions you allow will depend on the UC feature set that you use.
31
+
</Step>
32
+
<Step>
33
+
### Allow Password Grant Flow
36
34
37
-
These steps assume you use the default database in Auth0. If you use a custom database, and it's not clear how to adapt these steps for that database, contact us at [[email protected].](mailto:[email protected].)
35
+
Next, you need to allow the password grant flow in Auth0. This will let UserClouds capture passwords directly from your end users and verify those passwords with Auth0, rather than redirecting the users themselves to Auth0. This is required to capture any authentication changes for your active users, like new account creations and password resets.
38
36
39
-
- Select Settings in the Auth0 Sidebar, and scroll to the API Authorization Settings Card
40
-
- Copy Username-Password-Authentication into the Default Directory field and click Save
37
+
- In Auth0, navigate to your new M2M app’s settings page
38
+
- Click the Settings sub-tab, scroll to the Advanced Settings card and click the Grant Types tab
39
+
- Enable the Password Grant Flow and click Save
40
+
</Step>
41
+
<Step>
42
+
### Configure API Authorization in Auth0
41
43
42
-
## 2. Configure Auth0 as an Identity Provider in UserClouds
44
+
These steps assume you use the default database in Auth0. If you use a custom database, and it's not clear how to adapt these steps for that database, contact us at [[email protected].](mailto:[email protected].)
43
45
44
-
### 2a. Create a new Identity Provider in UserClouds
46
+
- Select Settings in the Auth0 Sidebar, and scroll to the API Authorization Settings Card
47
+
- Copy Username-Password-Authentication into the Default Directory field and click Save
45
48
46
-
- In a new tab, go to the UserClouds Console and select your tenant
47
-
- Navigate to the Authentication page and scroll down to Identity Platforms: Migrations & Back-Ups card
48
-
- Click Create Provider
49
+
</Step>
50
+
</Steps>
49
51
50
-
### 2b. Change your provider type to Auth0
52
+
## Configure Auth0 as an Identity Provider in UserClouds
53
+
<Steps>
54
+
<Step>
51
55
52
-
- Select the provider you just created
53
-
- Rename the provider something like Auth0 App Connection
54
-
Change the type to Auth0
56
+
### Create a new Identity Provider in UserClouds
55
57
56
-
### 2c. Copy over your Auth0 Provider Settings from Auth0
58
+
- In a new tab, go to the UserClouds Console and select your tenant
59
+
- Navigate to the Authentication page and scroll down to Identity Platforms: Migrations & Back-Ups card
60
+
- Click Create Provider
61
+
</Step>
62
+
<Step>
63
+
### Change your provider type to Auth0
57
64
58
-
- Back in your Auth0 tab, open the App page for your M2M app (which you called something like UserClouds Management App)
59
-
- Navigate to the Settings sub-tab and copy across the Domain, Client ID and Client Secret into the equivalent fields in UserClouds
60
-
- On the same Auth0 page, navigate to the APIs sub-tab, click the Auth0 Management API, and scroll down to the General Settings section
61
-
- Copy the Identifier field and paste it into the Audience field in the Auth0 Provider Settings card in UserClouds
62
-
- Click Save
65
+
- Select the provider you just created
66
+
- Rename the provider something like Auth0 App Connection
67
+
Change the type to Auth0
68
+
</Step>
69
+
<Step>
70
+
### Copy over your Auth0 Provider Settings from Auth0
63
71
64
-
## 3. Import your Auth0 applications to UserClouds
65
-
66
-
### 3a. Import your applications
72
+
- Back in your Auth0 tab, open the App page for your M2M app (which you called something like UserClouds Management App)
73
+
- Navigate to the Settings sub-tab and copy across the Domain, Client ID and Client Secret into the equivalent fields in UserClouds
74
+
- On the same Auth0 page, navigate to the APIs sub-tab, click the Auth0 Management API, and scroll down to the General Settings section
75
+
- Copy the Identifier field and paste it into the Audience field in the Auth0 Provider Settings card in UserClouds
76
+
- Click Save
77
+
</Step>
78
+
</Steps>
67
79
80
+
## Import your Auth0 applications to UserClouds
81
+
<Steps>
82
+
<Step>
83
+
### Import your applications
68
84
- In the same UserClouds page, scroll to the bottom card Import from Auth0 and click Import from Auth0
69
85
- This will import your Auth0 app configurations (like Client ID/Secret and Login URIs) into UserClouds
70
86
- The sync may take a moment - so refresh your page if you don't see any feedback immediately
71
-
72
-
### 3b. Review your application configurations
87
+
</Step>
88
+
<Step>
89
+
### Review your application configurations
73
90
74
91
- Next, it's beneficial to check your Auth0 configurations have successfully replicated in UserClouds, since you may be using an advanced configuration setting that UserClouds does not support migration for yet.
75
92
- Navigate to each UserClouds Application's page (UserClouds > Authentication > Login Application) and review the settings
- In UserClouds, navigate to the Authentication Page
81
99
- Scroll to the Identity Platforms: Migrations & Back-Ups card
82
100
- Set Auth0 to active provider and click Save
83
101
84
102
At this point, UserClouds will begin syncing your user profiles from Auth0. You will see your users appear in the End Users page in UserClouds. Passwords will not sync at this point.
85
-
86
-
## 5. Begin authenticating your users via UserClouds
103
+
</Step>
104
+
</Steps>
105
+
## Begin authenticating your users via UserClouds
87
106
88
107
Now you are ready to start authenticating your users via UserClouds. For more info on adding UserClouds to your software, see the previous article.
89
108
90
109
UserClouds will now begin syncing passwords for active users. When a user is logged in, they will log in via a UserClouds page, which will send the login credentials to the active provider (Auth0). If the login succeeds, the credentials will be stored in the UserClouds User Store.
91
110
92
-
## 6. Gather non-active users / passwords from Auth0
111
+
## Gather non-active users / passwords from Auth0
93
112
94
-
### 6a. Submit an Auth0 support ticket for salted / hashed passwords
113
+
<Steps>
114
+
<Step>
115
+
### Submit an Auth0 support ticket for salted / hashed passwords
95
116
96
117
- Go to the Auth0 support portal
97
118
- Submit a ticket requesting to export your hashed, salted passwords and MFA secrets for the relevant tenant, and requesting the hashing algorithms
98
119
- Respond to Auth0's support team confirming you want to export all hashed passwords and MFA secrets
99
120
Complete any other account verification steps
100
-
101
-
### 6b. Wait for Auth0 customer service
121
+
</Step>
122
+
<Step>
123
+
### Wait for Auth0 customer service
102
124
103
125
Auth0 can be slow here, so this step may take up to a few weeks. After this period, Auth0 will share your login data, correct as of the date that they ran your export. UserClouds will capture any authentication changes after this time (like new users or password resets), via Step 5.
104
-
105
-
### 6c. Import hashed password data to UserClouds
126
+
</Step>
127
+
<Step>
128
+
### Import hashed password data to UserClouds
106
129
107
130
Once Auth0 has shared your customer password data, you can upload it to UserClouds. Docs coming soon! For help, please email [[email protected].](mailto:[email protected].)
108
131
109
132
The UserClouds User Store now has all the login data of your inactive users (whose credentials are unchanged since the Auth0 export) and your active users (whose credentials were captured in Step 5). You have successfully exported all your user data from Auth0, without forcing any users to reset their password.
133
+
</Step>
134
+
</Steps>
110
135
111
-
## 7. Switch your active provider back to UserClouds
136
+
## Switch your active provider back to UserClouds
112
137
113
138
The final step is to switch your active provider back to UserClouds. This must be done at the tenant- and app-level.
114
-
115
-
### 7a. Switch your tenant's active provider to UserClouds
139
+
<Steps>
140
+
<Step>
141
+
### Switch your tenant's active provider to UserClouds
116
142
117
143
- In UserClouds, navigate to the Authentication Page
118
144
- Scroll to the Identity Platforms: Migrations & Back-Ups card
119
145
- Set Auth0 to active provider and click Save
120
-
121
-
### 7b. Switch your apps' active providers to UserClouds
146
+
</Step>
147
+
<Step>
148
+
### Switch your apps' active providers to UserClouds
122
149
123
150
- In UserClouds, navigate to the Authentication Page
124
151
- For each app
125
152
- Click the app to go into the Application page
126
153
- In the General Settings card, open the Underlying Identity Provider Apps accordion section
127
154
- Check the box for your tenant's UserClouds IDP
128
155
- Click Save
129
-
156
+
</Step>
157
+
</Steps>
130
158
Hooray! You did it. You successfully migrated off Auth0.
UserClouds is invite-only right now. If you don’t have an invite, please email [[email protected].](mailto:[email protected].) Click the link in your email invite and create a username and password. Congrats! You’ve now experienced UserClouds as an end-user.
14
+
<Steps>
15
+
<Step>
16
+
## Create an account
15
17
16
-
## 2. Name your organization and tenant
18
+
UserClouds is invite-only right now. If you don’t have an invite, please email [[email protected].](mailto:[email protected].) Click the link in your email invite and create a username and password. Congrats! You’ve now experienced UserClouds as an end-user.
19
+
</Step>
20
+
<Step>
21
+
## Name your organization and tenant
17
22
18
-
If you’re setting up your company’s account with UserClouds, you’ll be prompted to name your organization and your first tenant.
23
+
If you’re setting up your company’s account with UserClouds, you’ll be prompted to name your organization and your first tenant.
19
24
20
-
-**A company** is a collection of users and tenants. It allows you to group applications together and collaborate with team-mates. Typically, customers set up one organization for their company.
21
-
-**A tenant** is a single instance of UserClouds's tech (APIs, user store etc). Each tenant can handle multiple applications. Typically, customers set up one tenant per environment (e.g.. dev / testing / production). We also see enterprise-facing companies create a separate tenant for each one of their customers if/where they need data isolation.
25
+
-**A company** is a collection of users and tenants. It allows you to group applications together and collaborate with team-mates. Typically, customers set up one organization for their company.
26
+
-**A tenant** is a single instance of UserClouds's tech (APIs, user store etc). Each tenant can handle multiple applications. Typically, customers set up one tenant per environment (e.g.. dev / testing / production). We also see enterprise-facing companies create a separate tenant for each one of their customers if/where they need data isolation.
27
+
</Step>
28
+
<Step>
29
+
## Rename your application
22
30
23
-
## 3. Rename your application
31
+
You’ll land on the Authentication Page for your Tenant in UserClouds. This is where you can configure your tenant’s applications, underlying IDPs, Social and 3rd Party IDPs and settings.
24
32
25
-
You’ll land on the Authentication Page for your Tenant in UserClouds. This is where you can configure your tenant’s applications, underlying IDPs, Social and 3rd Party IDPs and settings.
33
+
UserClouds automatically creates a Default Application for each tenant.
26
34
27
-
UserClouds automatically creates a Default Application for each tenant.
28
-
29
-
-**An application** is a single OAuth2 client that can call the APIs of any IDPs configured in your tenant (e.g. primary - Auth0, back-up - Plex, third party - social). It is where you will configure how authentication works for your project. For example, you might configure the application to require two factor authentication via SMS or offer passwordless login.
30
-
31
-
To rename your application, click into the application, hit edit, change the name, and click Save. In UserClouds, you must always click Save to commit your changes.
35
+
-**An application** is a single OAuth2 client that can call the APIs of any IDPs configured in your tenant (e.g. primary - Auth0, back-up - Plex, third party - social). It is where you will configure how authentication works for your project. For example, you might configure the application to require two factor authentication via SMS or offer passwordless login.
32
36
37
+
To rename your application, click into the application, hit edit, change the name, and click Save. In UserClouds, you must always click Save to commit your changes.
38
+
</Step>
39
+
</Steps>
33
40
Hooray! You created your first application in UserClouds. Now let’s see how to add UserClouds to your software.
0 commit comments