Skip to content

Commit

Permalink
docs: Update migration guide for Auth0 v4.x changes
Browse files Browse the repository at this point in the history
  • Loading branch information
kushalshit27 committed Jan 16, 2025
1 parent e193f7f commit ebe8ad1
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions docs/v8_MIGRATION_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
Guide to migrating from `7.x` to `8.x`

- [General](#general)
- [Node 18 or newer is required](#node-18-or-newer-is-required)
- [Auth0 V4 Migration Guide](https://github.com/auth0/node-auth0/blob/master/v4_MIGRATION_GUIDE.md)
- [Node 18 or newer is required](#node-18-or-newer-is-required)
- [Auth0 V4 Migration Guide](https://github.com/auth0/node-auth0/blob/master/v4_MIGRATION_GUIDE.md)
- [Management Resources](#management-resources)
- [EmailProvider](#emailProvider)
- [Migrations](#migrations)
- [EmailProvider](#emailProvider)
- [Migrations](#migrations)

## General

Expand All @@ -18,29 +18,27 @@ Node 18 LTS and newer LTS releases are supported.
## Management Resources

| Resource | Change | Description |
|---------------|------------------|-----------------------------------------------|
| ------------- | ---------------- | --------------------------------------------- |
| emailProvider | delete operation | Delete operation is deprecated on auth0 `4.x` |
| migrations | removed support | Not supported on auth0 `4.x` |

#### Note: Other resources from `7.x` are not affected and no changes are required.

#### emailProvider
#### emailProvider :

The `delete` operation on the `emailProvider` resource will disable the email provider instead of deleting it.
This is because the email provider deletion operation is deprecated on auth0 `4.x`. User can disable the email provider
This is because the email provider deletion operation is not supported on auth0 `4.x`. User can disable the email provider
by email provider setting the `enabled` property to `false` from the configuration file.

```yaml
emailProvider:
# other properties
enabled: false
emailProvider:
# other properties
enabled: false
```
Rest of the operations on emailProvider resource will work the same as `7.x`.

#### migrations
#### migrations :

The `migrations` resource is not supported on auth0 `4.x`. It's recommended to remove the `migrations` resource from the
configuration file. If it's not removed, the deploy CLI will ignore the `migrations` resource for operations.


0 comments on commit ebe8ad1

Please sign in to comment.