Skip to content

Commit 1e53a75

Browse files
committed
docs: improve formatting in auth0 migration to follow our style guide.
1 parent f405dbb commit 1e53a75

File tree

1 file changed

+31
-29
lines changed

1 file changed

+31
-29
lines changed

docs/migrate-to-ory/auth0.mdx

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,29 @@ If your setup is different, you can use this document as a starting point in def
1717

1818
Before you begin, ensure you have:
1919

20-
- **Auth0 account** with admin access to export user data
21-
- **Ory account** and CLI installed
20+
- Auth0 account with admin access to export user data
21+
- Ory account and CLI installed
2222
{/* TODO: change this to refer to new migration guide (docs/migrate-to-ory/migrate/create-project.mdx) */}
23-
- **Ory project** created - See [creating a project](index.mdx) for instructions
24-
- **Required tools**:
23+
- Ory project created - See [creating a project](index.mdx) for instructions
24+
- Required tools:
2525
- [jq](https://jqlang.org/) - Command-line JSON processor
2626
- [Gzip](https://www.gnu.org/software/gzip/) - Compression utility
2727
- [Ory CLI](../guides/cli/01_installation.mdx) - Ory command-line interface
28-
- **Time estimate**: 1-2 hours depending on the number of users
28+
- Time estimate: 1-2 hours depending on the number of users
2929

3030
## Overview
3131

3232
The migration process consists of three phases:
3333

34-
1. **Prepare your Auth0 data** - Export user data and password hashes
35-
2. **Configure your Ory project** - Set up identity schema for email authentication
36-
3. **Import users to Ory** - Run the migration script to create users in Ory
34+
1. [Prepare your Auth0 data](#prepare-your-auth0-data): Export user data and password hashes
35+
2. [Configure your Ory project](#configure-your-ory-project): Set up identity schema for email authentication
36+
3. [Import users to Ory](#import-users-to-ory): Run the migration script to create users in Ory
3737

3838
---
3939

40-
## Phase 1: Prepare your Auth0 data
40+
## Prepare your Auth0 data
4141

42-
### 1. Create bulk user export
42+
### Create bulk user export
4343

4444
To create a [bulk user export](https://auth0.com/docs/manage-users/user-migration/bulk-user-exports), you need a Management API
4545
Access Token and the ID of your connection. This data is used by the migration script you run to get the user data. You can
@@ -84,17 +84,21 @@ Follow these steps to export the user data:
8484
bash <(curl https://raw.githubusercontent.com/ory/docs/master/code-examples/migrate-to-ory/0-get-auth0-user-data.sh)
8585
```
8686

87-
This script creates `AUTH0_USERDATA.json` in your current directory containing all exported user data.
87+
This script creates `AUTH0_USERDATA.json` in your current directory and contains all the exported user data.
8888

89-
### 2. Export password hashes
89+
### Export password hashes
9090

9191
Exporting password hashes is optional but recommended. Because password hashes are considered sensitive information, Auth0 doesn't
9292
export them as part of the general export process. To get the password hashes and other password-related information, you must
9393
[create an Auth0 support ticket](#create-auth0-support-ticket).
9494

9595
If you get your users' password hashes and import them to Ory, users can log in to their accounts using the same credentials they
96-
used before the migration. If you can't get users' password hashes, you can still import Auth0 user accounts to Ory and migrate
97-
them using a [Password migration hook](../kratos/manage-identities/25_import-user-accounts-identities.mdx).
96+
used before the migration. For more information, see
97+
[Bulk identity migration](../migrate-to-ory/migrate/migrate-strategies#bulk-identity-migration).
98+
99+
- If you can't get users' password hashes, you can still import Auth0 user accounts to Ory and migrate them using a
100+
[Password migration hook](../kratos/manage-identities/25_import-user-accounts-identities.mdx). For more information, see
101+
[Graceful identity migration](../migrate-to-ory/migrate/migrate-strategies#graceful-identity-migration).
98102

99103
:::note
100104

@@ -127,9 +131,9 @@ The file you get has this format:
127131

128132
---
129133

130-
## Phase 2: Configure your Ory project
134+
## Configure your Ory project
131135

132-
### 1. Set environment variables
136+
### Set environment variables
133137

134138
Set your project and workspace IDs as environment variables:
135139

@@ -142,13 +146,12 @@ export ORY_WORKSPACE_ID='{your-workspace-id}'
142146

143147
If you don't have these values, you can retrieve them:
144148

145-
- **Using the CLI**: Run `ory list projects` to see all your projects and their IDs
146-
- **Using the Console**: Go to [Ory Console](https://console.ory.sh/), select your project, and find the IDs in the project
147-
settings
149+
- Using the CLI: Run `ory list projects` to see all your projects and their IDs
150+
- Using the Console: Go to [Ory Console](https://console.ory.sh/), select your project, and find the IDs in the project settings
148151

149152
:::
150153

151-
### 2. Configure identity schema
154+
### Configure identity schema
152155

153156
Before importing users, you need to configure your Ory project's identity schema to match your Auth0 setup. Since Auth0 users
154157
authenticate with email and password, configure the identity schema to use the email preset.
@@ -163,9 +166,9 @@ ory patch identity-config --project $ORY_PROJECT_ID --workspace $ORY_WORKSPACE_I
163166

164167
---
165168

166-
## Phase 3: Import users to Ory
169+
## Import users to Ory
167170

168-
### 1. Configure environment variables
171+
### Configure environment variables
169172

170173
Configure the migration script by exporting the necessary environment variables:
171174

@@ -182,7 +185,7 @@ export AUTH0_PWEXPORT="{path-to-the-json-file-with-password-hashes}"
182185

183186
:::
184187

185-
### 2. Run import script
188+
### Run import script
186189

187190
Execute the migration script to import users:
188191

@@ -199,25 +202,24 @@ You can inspect the script
199202

200203
After the import script completes, follow these steps to verify and finalize the migration:
201204

202-
1. **Verify the migration**: Check the list of users available in your project to confirm the import was successful:
205+
1. Verify the migration: Check the list of users available in your project to confirm the import was successful:
203206

204207
```shell
205208
ory list identities --project $ORY_PROJECT_ID --workspace $ORY_WORKSPACE_ID
206209
```
207210

208-
2. **Test user login**: Try logging in with a few test accounts to ensure the migration was successful.
211+
2. Test user login: Try logging in with a few test accounts to ensure the migration was successful.
209212

210-
3. **Enable account recovery** (if migrating without password hashes):
213+
3. Enable account recovery (if migrating without password hashes):
211214

212215
- Users will need to reset their passwords on first login
213216
- Ensure [account recovery](../kratos/self-service/flows/account-recovery-password-reset) is enabled
214217
- Communicate this to your users before migration
215218

216-
4. **Communicate with users**: Inform your users about:
219+
4. Communicate with users: Inform your users about:
217220

218221
- The migration timeline
219222
- Any actions they need to take (password reset if migrating without password hashes)
220223
- How to get support if they encounter issues
221224

222-
5. **Monitor the migration**: Keep track of user login attempts and any issues that arise during the first few days after
223-
migration.
225+
5. Monitor the migration: Keep track of user login attempts and any issues that arise during the first few days after migration.

0 commit comments

Comments
 (0)