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/authentication-methods.mdx
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,13 @@ title: "Add social login"
3
3
slug: "authentication-methods"
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:51:23 GMT+0000 (Coordinated Universal Time)"
10
10
updatedAt: "Fri Aug 25 2023 21:43:12 GMT+0000 (Coordinated Universal Time)"
11
11
---
12
+
12
13
UserClouds supports every major method of authentication, such as social sign in with Google, Facebook and LinkedIn OAuth. The user's accounts will be owned by the Identity Platforms configured in “Underlying Identity Providers”.
13
14
14
15
Adding a Social/Third Party Connections to a login flow can be completed in three steps:
@@ -41,8 +42,4 @@ Now your tenant is connected to the third party, you can add their authenticatio
41
42
1. Navigate to the Application page (Select Tenant > Authentication > Application)
42
43
2. Create social redirect and logout URIs for that application, e.g. `https://tenantname.tenant.userclouds.com/social/callback`
43
44
3. Add these URIs to your account with the third party (see links in part 1)
44
-
4. Select which authentication methods are enabled in the Login Settings card. You can also configure other authentication methods, like Passwordless / Magic Link, from this card.
4. Select which authentication methods are enabled in the Login Settings card. You can also configure other authentication methods, like Passwordless / Magic Link, from this card.
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.
12
13
13
14
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.
14
15
15
-
The article assumes you have already set up an account, organization, tenant and application in UserClouds. See here for more info.
16
+
The article assumes you have already set up an account, organization, tenant and application in UserClouds. See here for more info.
16
17
18
+
## Ready your Auth0 account
17
19
18
-
## Ready your Auth0 account
19
20
<Steps>
20
21
<Step>
21
-
### Create an M2M application in Auth0
22
+
### Create an M2M application in Auth0
22
23
23
-
First, you need to create an M2M application in Auth0, so that UserClouds's server can call the Auth0 server:
24
+
First, you need to create an M2M application in Auth0, so that UserClouds's server can call the Auth0 server:
24
25
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
26
+
- Log into Auth0 & click Applications in the sidebar
27
+
- Click Create Application.
28
+
- Call your application something like UserClouds Management App
29
+
- Select M2M and hit Create
29
30
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
31
+
- 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.
32
+
</Step>
34
33
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.
34
+
<Step>
36
35
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
36
+
### Allow Password Grant Flow
43
37
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].)
38
+
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.
45
39
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
40
+
- In Auth0, navigate to your new M2M app’s settings page
41
+
- Click the Settings sub-tab, scroll to the Advanced Settings card and click the Grant Types tab
42
+
- Enable the Password Grant Flow and click Save
43
+
</Step>
44
+
<Step>
48
45
49
-
</Step>
46
+
### Configure API Authorization in Auth0
47
+
48
+
These steps assume you use the default database in Auth0.
49
+
50
+
- Select Settings in the Auth0 Sidebar, and scroll to the API Authorization Settings Card
51
+
- Copy Username-Password-Authentication into the Default Directory field and click Save
52
+
53
+
</Step>
50
54
</Steps>
51
55
52
56
## Configure Auth0 as an Identity Provider in UserClouds
57
+
53
58
<Steps>
54
59
<Step>
55
-
56
60
### Create a new Identity Provider in UserClouds
57
61
58
62
- In a new tab, go to the UserClouds Console and select your tenant
@@ -63,7 +67,7 @@ The article assumes you have already set up an account, organization, tenant and
63
67
### Change your provider type to Auth0
64
68
65
69
- Select the provider you just created
66
-
- Rename the provider something like Auth0 App Connection
70
+
- Rename the provider something like Auth0 App Connection
67
71
Change the type to Auth0
68
72
</Step>
69
73
<Step>
@@ -78,81 +82,81 @@ The article assumes you have already set up an account, organization, tenant and
78
82
</Steps>
79
83
80
84
## Import your Auth0 applications to UserClouds
85
+
81
86
<Steps>
82
-
<Step>
83
-
### Import your applications
84
-
- In the same UserClouds page, scroll to the bottom card Import from Auth0 and click Import from Auth0
85
-
- This will import your Auth0 app configurations (like Client ID/Secret and Login URIs) into UserClouds
86
-
- The sync may take a moment - so refresh your page if you don't see any feedback immediately
87
-
</Step>
88
-
<Step>
89
-
### Review your application configurations
90
-
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.
92
-
- Navigate to each UserClouds Application's page (UserClouds > Authentication > Login Application) and review the settings
- In UserClouds, navigate to the Authentication Page
99
-
- Scroll to the Identity Platforms: Migrations & Back-Ups card
100
-
- Set Auth0 to active provider and click Save
101
-
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.
103
-
</Step>
87
+
<Step>
88
+
### Import your applications
89
+
- In the same UserClouds page, scroll to the bottom card Import from Auth0 and click Import from Auth0
90
+
- This will import your Auth0 app configurations (like Client ID/Secret and Login URIs) into UserClouds
91
+
- The sync may take a moment - so refresh your page if you don't see any feedback immediately
92
+
</Step>
93
+
<Step>
94
+
### Review your application configurations
95
+
96
+
- 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.
97
+
- Navigate to each UserClouds Application's page (UserClouds > Authentication > Login Application) and review the settings
98
+
</Step>
99
+
<Step>
100
+
## Make Auth0 your active provider
101
+
102
+
- In UserClouds, navigate to the Authentication Page
103
+
- Scroll to the Identity Platforms: Migrations & Back-Ups card
104
+
- Set Auth0 to active provider and click Save
105
+
106
+
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.
107
+
</Step>
104
108
</Steps>
109
+
105
110
## Begin authenticating your users via UserClouds
106
111
107
112
Now you are ready to start authenticating your users via UserClouds. For more info on adding UserClouds to your software, see the previous article.
108
113
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.
114
+
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.
110
115
111
116
## Gather non-active users / passwords from Auth0
112
117
113
118
<Steps>
114
-
<Step>
115
-
### Submit an Auth0 support ticket for salted / hashed passwords
119
+
<Step>
120
+
### Submit an Auth0 support ticket for salted / hashed passwords
116
121
117
-
- Go to the Auth0 support portal
118
-
- Submit a ticket requesting to export your hashed, salted passwords and MFA secrets for the relevant tenant, and requesting the hashing algorithms
119
-
- Respond to Auth0's support team confirming you want to export all hashed passwords and MFA secrets
120
-
Complete any other account verification steps
121
-
</Step>
122
-
<Step>
123
-
### Wait for Auth0 customer service
122
+
- Go to the Auth0 support portal
123
+
- Submit a ticket requesting to export your hashed, salted passwords and MFA secrets for the relevant tenant, and requesting the hashing algorithms
124
+
- Respond to Auth0's support team confirming you want to export all hashed passwords and MFA secrets
125
+
Complete any other account verification steps
126
+
</Step>
127
+
<Step>
128
+
### Wait for Auth0 customer service
129
+
130
+
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.
131
+
132
+
</Step>
133
+
<Step>
134
+
### Import hashed password data to UserClouds
124
135
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.
126
-
</Step>
127
-
<Step>
128
-
### Import hashed password data to UserClouds
136
+
Once Auth0 has shared your customer password data, you can upload it to UserClouds.
129
137
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].)
138
+
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.
131
139
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
140
</Step>
134
141
</Steps>
135
142
136
143
## Switch your active provider back to UserClouds
137
144
138
145
The final step is to switch your active provider back to UserClouds. This must be done at the tenant- and app-level.
146
+
139
147
<Steps>
140
-
<Step>
141
-
### Switch your tenant's active provider to UserClouds
142
-
143
-
- In UserClouds, navigate to the Authentication Page
144
-
- Scroll to the Identity Platforms: Migrations & Back-Ups card
145
-
- Set Auth0 to active provider and click Save
146
-
</Step>
147
-
<Step>
148
-
### Switch your apps' active providers to UserClouds
149
-
150
-
- In UserClouds, navigate to the Authentication Page
151
-
- For each app
152
-
- Click the app to go into the Application page
153
-
- In the General Settings card, open the Underlying Identity Provider Apps accordion section
154
-
- Check the box for your tenant's UserClouds IDP
155
-
- Click Save
156
-
</Step>
148
+
<Step>
149
+
### Switch your tenant's active provider to UserClouds
150
+
151
+
- In UserClouds, navigate to the Authentication Page
152
+
- Scroll to the Identity Platforms: Migrations & Back-Ups card
153
+
- Set Auth0 to active provider and click Save
154
+
</Step>
155
+
<Step>
156
+
### Switch your apps' active providers to UserClouds
157
+
158
+
- In UserClouds, navigate to the Authentication Page
159
+
- For each app - Click the app to go into the Application page - In the General Settings card, open the Underlying Identity Provider Apps accordion section - Check the box for your tenant's UserClouds IDP - Click Save
160
+
</Step>
157
161
</Steps>
158
162
Hooray! You did it. You successfully migrated off Auth0.
createdAt: "Thu Aug 03 2023 22:56:54 GMT+0000 (Coordinated Universal Time)"
10
10
updatedAt: "Fri Aug 25 2023 21:43:53 GMT+0000 (Coordinated Universal Time)"
11
11
---
12
+
12
13
## Default fields
13
14
14
15
You may wish to collect certain user data on sign up, e.g. name, date of birth or phone number. You can add fields to your sign-up form in the Login Experience card of the Application Settings Page. This is reached by selecting the Application in your Tenant’s Authentication page.
Copy file name to clipboardExpand all lines: content/docs/guides/(authentication)/how-to-guides/two-factor-authentication.mdx
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,18 +3,15 @@ title: "Set up two factor authentication (2FA)"
3
3
slug: "two-factor-authentication"
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:54:25 GMT+0000 (Coordinated Universal Time)"
10
10
updatedAt: "Fri Aug 25 2023 21:43:25 GMT+0000 (Coordinated Universal Time)"
11
11
---
12
-
UserClouds supports 2 Factor Authentication via email and text. By default, two factor authentication is switched off.
12
+
13
+
UserClouds supports 2 Factor Authentication via email and text. By default, two factor authentication is switched off.
13
14
14
15
## Email 2FA
15
16
16
17
To turn on two factor authentication by email for a given application, go to the Authentication tab, select the Application and scroll to the Login Experience card. Under Authentication Settings, check the box that says "Require 2FA by email" and click Save.
Copy file name to clipboardExpand all lines: content/docs/guides/(authentication)/quickstart-guides/add-userclouds-to-your-software.mdx
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,7 @@ hidden: false
6
6
createdAt: "Thu Aug 03 2023 22:43:44 GMT+0000 (Coordinated Universal Time)"
7
7
updatedAt: "Mon Nov 04 2024 20:08:29 GMT+0000 (Coordinated Universal Time)"
8
8
---
9
+
9
10
You’ve already created your first application in UserClouds. Nice job! This page shows how to set up UserClouds Authentication on your software.
10
11
11
12
## 1. Specify your allowed Redirect and Logout URLs
@@ -19,13 +20,11 @@ Remember to click Save to apply this change!
19
20
20
21
## 2. Cut and paste your UserClouds settings into the sample app code
21
22
22
-
Each UserClouds application has four key attributes: an application ID, an application name, a client ID and a client secret. You will need your Client ID and Client Secret, when you use your TenantURL to call UserClouds's APIs.
23
+
Each UserClouds application has four key attributes: an application ID, an application name, a client ID and a client secret. You will need your Client ID and Client Secret, when you use your TenantURL to call UserClouds's APIs.
23
24
Before you use the sample code elsewhere, make sure you replace the sample app’s instances of these variables with your application’s attributes. You can find these on your Application’s Settings page.
24
25
25
26
## 3. Implement UserClouds in your software
26
27
27
28
Use the sample code (or any other OIDC library you like) as a template to add UserClouds to your application.
0 commit comments