V6 Migration Guide

A guide to migrating the Auth0 Node.js SDK from 5.x to 6.x.

• Overall changes
• Breaking changes
  • ConnectionAttributeIdentifier replaced with identifier-specific types
  • PhoneProviderProtectionBackoffStrategyEnum value change
  • users.federatedConnectionsTokensets removed
  • federated_connections_access_tokens removed from connection options

Overall changes

V6 addresses type correctness for database connection attribute identifiers, aligns the phone provider backoff strategy enum with the updated API, and removes the federated connections tokensets user sub-client. There are no changes to the Authentication API — any code written for the Authentication API in 5.x will continue to work in 6.x.

Breaking changes

ConnectionAttributeIdentifier replaced with identifier-specific types

In v5, all three attribute identifiers (email, phone number, and username) shared a single ConnectionAttributeIdentifier type for their identifier field. This was incorrect — each identifier type supports different values for default_method.

In v6, ConnectionAttributeIdentifier has been removed and replaced with three separate types:

Before (v5):

import { Management } from "auth0";

const identifier: Management.ConnectionAttributeIdentifier = {
    active: true,
    default_method: "email_otp",
};

After (v6):

import { Management } from "auth0";

// For email attribute
const emailIdentifier: Management.EmailAttributeIdentifier = {
    active: true,
    default_method: "email_otp",
};

// For phone_number attribute
const phoneIdentifier: Management.PhoneAttributeIdentifier = {
    active: true,
    default_method: "phone_otp",
};

// For username attribute (no default_method)
const usernameIdentifier: Management.UsernameAttributeIdentifier = {
    active: true,
};

If you were using ConnectionAttributeIdentifier as a type annotation in your own code, update it to the appropriate identifier-specific type based on which attribute it applies to.

PhoneProviderProtectionBackoffStrategyEnum value change

The PhoneProviderProtectionBackoffStrategyEnum enum has been updated to reflect a change in the Auth0 API. The None variant has been renamed to Default, and its string value has changed from "none" to "default".

Before (v5):

import { Management } from "auth0";

const strategy = Management.PhoneProviderProtectionBackoffStrategyEnum.None; // "none"

After (v6):

import { Management } from "auth0";

const strategy = Management.PhoneProviderProtectionBackoffStrategyEnum.Default; // "default"

If you were passing this value directly as a string "none", update it to "default" to match the updated API.

users.federatedConnectionsTokensets removed

The client.users.federatedConnectionsTokensets sub-client has been removed. This includes the list() and delete() methods.

Before (v5):

// List active federated connection tokensets for a user
const tokensets = await client.users.federatedConnectionsTokensets.list("user_id");

// Delete a tokenset
await client.users.federatedConnectionsTokensets.delete("user_id", "tokenset_id");

After (v6):

These methods are no longer available. Remove any calls to client.users.federatedConnectionsTokensets from your code.

federated_connections_access_tokens removed from connection options

The federated_connections_access_tokens field has been removed from all connection option types, including create and update. This affects OIDC, Azure AD, Google Apps, and other connection strategies. Remove it from any create or update payloads.

Before (v5):

// On create
await client.connections.create({
    strategy: "oidc",
    name: "my-connection",
    options: {
        federated_connections_access_tokens: { ... },
        // other options
    },
});

// On update
await client.connections.update("connection_id", {
    options: {
        federated_connections_access_tokens: { ... },
        // other options
    },
});

After (v6):

// On create
await client.connections.create({
    strategy: "oidc",
    name: "my-connection",
    options: {
        // remove federated_connections_access_tokens
        // other options
    },
});

// On update
await client.connections.update("connection_id", {
    options: {
        // remove federated_connections_access_tokens
        // other options
    },
});