From 669f35837b5a3f3bedce54d1f5ffb1d30826c458 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Tue, 21 Jul 2026 07:20:03 +0000 Subject: [PATCH 1/2] [fern-generated] Update SDK Generated by Fern CLI Version: unknown Generators: - fernapi/fern-typescript-sdk: 3.72.5 --- src/management/api/requests/requests.ts | 9 +- src/management/api/types/types.ts | 150 +++++++++++++++ .../tests/wire/branding/themes.test.ts | 20 ++ src/management/tests/wire/clients.test.ts | 5 + .../tests/wire/clients/connections.test.ts | 1 + src/management/tests/wire/connections.test.ts | 4 + src/management/tests/wire/sessions.test.ts | 2 + .../tests/wire/users/sessions.test.ts | 1 + src/management/version.ts | 2 +- v6_MIGRATION_GUIDE.md | 158 ---------------- yarn.lock | 176 +++++++++--------- 11 files changed, 280 insertions(+), 248 deletions(-) delete mode 100644 v6_MIGRATION_GUIDE.md diff --git a/src/management/api/requests/requests.ts b/src/management/api/requests/requests.ts index 2f8d3f7c3d..bb044ac89b 100644 --- a/src/management/api/requests/requests.ts +++ b/src/management/api/requests/requests.ts @@ -216,7 +216,7 @@ export interface ListClientsRequestParameters { is_first_party?: boolean | null; /** Optional filter by a comma-separated list of application types. */ app_type?: string | null; - /** Optional filter by the Client ID Metadata Document URI for CIMD-registered clients. */ + /** Optional filter by the Client ID Metadata Document URI for CIMD-registered clients. */ external_client_id?: string | null; /** Advanced Query in Lucene syntax.
Permitted Queries:
Additional Restrictions:
Note: Recent updates may not be immediately reflected in query results */ q?: string | null; @@ -312,6 +312,7 @@ export interface CreateClientRequestContent { token_quota?: Management.CreateTokenQuota; /** The identifier of the resource server that this client is linked to. */ resource_server_identifier?: string; + identity_assertion_authorization_grant?: Management.CreateIdentityAssertionAuthorizationGrant; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum; redirection_policy?: Management.ClientRedirectionPolicyEnum; express_configuration?: Management.ExpressConfiguration; @@ -412,6 +413,7 @@ export interface UpdateClientRequestContent { custom_login_page?: string; custom_login_page_preview?: string; token_quota?: Management.UpdateTokenQuota | null; + identity_assertion_authorization_grant?: Management.UpdateIdentityAssertionAuthorizationGrant | null; /** Form template for WS-Federation protocol */ form_template?: string; addons?: Management.ClientAddons; @@ -548,6 +550,7 @@ export interface CreateConnectionRequestContent { authentication?: Management.ConnectionAuthenticationPurpose; connected_accounts?: Management.ConnectionConnectedAccountsPurpose; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp; + cross_app_access_resource_app?: Management.CreateCrossAppAccessResourceApp; } /** @@ -584,6 +587,7 @@ export interface UpdateConnectionRequestContent { authentication?: Management.ConnectionAuthenticationPurpose; connected_accounts?: Management.ConnectionConnectedAccountsPurpose; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp; + cross_app_access_resource_app?: Management.UpdateCrossAppAccessResourceApp | null; } /** @@ -2349,6 +2353,7 @@ export interface CreateBrandingThemeRequestContent { /** Display Name */ displayName?: string; fonts: Management.BrandingThemeFonts; + identifiers?: Management.BrandingThemeIdentifiers; page_background: Management.BrandingThemePageBackground; widget: Management.BrandingThemeWidget; } @@ -2434,6 +2439,7 @@ export interface UpdateBrandingThemeRequestContent { /** Display Name */ displayName?: string; fonts: Management.BrandingThemeFonts; + identifiers?: Management.BrandingThemeIdentifiers; page_background: Management.BrandingThemePageBackground; widget: Management.BrandingThemeWidget; } @@ -3874,6 +3880,7 @@ export interface CreateSelfServiceProfileSsoTicketRequestContent { provisioning_config?: Management.SelfServiceProfileSsoTicketProvisioningConfig; /** Indicates whether a verified domain should be used for organization discovery during authentication. */ use_for_organization_discovery?: boolean; + third_party_client_access_config?: Management.ThirdPartyClientAccessConfig; enabled_features?: Management.SelfServiceProfileSsoTicketEnabledFeatures; } diff --git a/src/management/api/types/types.ts b/src/management/api/types/types.ts index 6a0aa9fd4f..829da13868 100644 --- a/src/management/api/types/types.ts +++ b/src/management/api/types/types.ts @@ -1785,6 +1785,46 @@ export interface BrandingThemeFonts { title: Management.BrandingThemeFontTitle; } +export interface BrandingThemeIdentifiers { + login_display: Management.BrandingThemeIdentifiersLoginDisplayEnum; + /** OTP autocomplete */ + otp_autocomplete: boolean; + phone_display: Management.BrandingThemeIdentifiersPhoneDisplay; +} + +/** Login display */ +export const BrandingThemeIdentifiersLoginDisplayEnum = { + Separate: "separate", + Unified: "unified", +} as const; +export type BrandingThemeIdentifiersLoginDisplayEnum = + (typeof BrandingThemeIdentifiersLoginDisplayEnum)[keyof typeof BrandingThemeIdentifiersLoginDisplayEnum]; + +/** + * Phone display + */ +export interface BrandingThemeIdentifiersPhoneDisplay { + formatting: Management.BrandingThemeIdentifiersPhoneDisplayFormattingEnum; + masking: Management.BrandingThemeIdentifiersPhoneDisplayMaskingEnum; +} + +/** Phone number formatting style */ +export const BrandingThemeIdentifiersPhoneDisplayFormattingEnum = { + International: "international", + Regional: "regional", +} as const; +export type BrandingThemeIdentifiersPhoneDisplayFormattingEnum = + (typeof BrandingThemeIdentifiersPhoneDisplayFormattingEnum)[keyof typeof BrandingThemeIdentifiersPhoneDisplayFormattingEnum]; + +/** Phone number masking strategy */ +export const BrandingThemeIdentifiersPhoneDisplayMaskingEnum = { + HideCountryCode: "hide_country_code", + MaskDigits: "mask_digits", + ShowAll: "show_all", +} as const; +export type BrandingThemeIdentifiersPhoneDisplayMaskingEnum = + (typeof BrandingThemeIdentifiersPhoneDisplayMaskingEnum)[keyof typeof BrandingThemeIdentifiersPhoneDisplayMaskingEnum]; + export interface BrandingThemePageBackground { /** Background color */ background_color: string; @@ -2122,6 +2162,7 @@ export interface Client { token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; + identity_assertion_authorization_grant?: Management.IdentityAssertionAuthorizationGrant | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ @@ -2552,6 +2593,7 @@ export const ClientAppTypeEnum = { NonInteractive: "non_interactive", ResourceServer: "resource_server", ExpressConfiguration: "express_configuration", + B2BIntegration: "b2b_integration", Rms: "rms", Box: "box", Cloudbees: "cloudbees", @@ -2816,6 +2858,7 @@ export interface ClientGrantResponseContent { export const ClientGrantSubjectTypeEnum = { Client: "client", User: "user", + AnonymousUser: "anonymous_user", } as const; export type ClientGrantSubjectTypeEnum = (typeof ClientGrantSubjectTypeEnum)[keyof typeof ClientGrantSubjectTypeEnum]; @@ -3673,6 +3716,21 @@ export const ConnectionConnectionSettingsPkceEnum = { export type ConnectionConnectionSettingsPkceEnum = (typeof ConnectionConnectionSettingsPkceEnum)[keyof typeof ConnectionConnectionSettingsPkceEnum]; +/** + * Cross App Access - Resource App settings that apply to this connection. + */ +export interface ConnectionCrossAppAccessResourceApp { + status: Management.ConnectionCrossAppAccessResourceAppStatusEnum; +} + +/** Set to `enabled` to accept ID-JAGs from this connection's identity provider to issue access tokens to other connected applications. */ +export const ConnectionCrossAppAccessResourceAppStatusEnum = { + Disabled: "disabled", + Enabled: "enabled", +} as const; +export type ConnectionCrossAppAccessResourceAppStatusEnum = + (typeof ConnectionCrossAppAccessResourceAppStatusEnum)[keyof typeof ConnectionCrossAppAccessResourceAppStatusEnum]; + /** * Custom HTTP headers sent with token exchange requests to the identity provider's token endpoint. Provided as key-value pairs (e.g., {'X-Custom-Header': 'value'}). Auth0's User-Agent header is always included by default. */ @@ -3969,6 +4027,7 @@ export interface ConnectionForList { authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp | undefined; + cross_app_access_resource_app?: Management.CrossAppAccessResourceApp | undefined; } /** @@ -6727,6 +6786,7 @@ export interface ConnectionResponseContentOidc extends Management.ConnectionResp authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurposeXaa | undefined; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp | undefined; + cross_app_access_resource_app?: (Management.ConnectionCrossAppAccessResourceApp | null) | undefined; options?: Management.ConnectionOptionsOidc | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } @@ -7916,6 +7976,7 @@ export interface CreateBrandingThemeResponseContent { /** Display Name */ displayName: string; fonts: Management.BrandingThemeFonts; + identifiers?: Management.BrandingThemeIdentifiers | undefined; page_background: Management.BrandingThemePageBackground; /** Theme Id */ themeId: string; @@ -8047,6 +8108,7 @@ export interface CreateClientResponseContent { token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; + identity_assertion_authorization_grant?: Management.IdentityAssertionAuthorizationGrant | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ @@ -8550,6 +8612,7 @@ export interface CreateConnectionRequestContentOidc extends Management.CreateCon authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurposeXaa | undefined; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp | undefined; + cross_app_access_resource_app?: (Management.ConnectionCrossAppAccessResourceApp | null) | undefined; options?: Management.ConnectionOptionsOidc | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } @@ -8950,6 +9013,14 @@ export interface CreateConnectionResponseContent { authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp | undefined; + cross_app_access_resource_app?: Management.CrossAppAccessResourceApp | undefined; +} + +/** + * Cross App Access - Resource App settings that apply to this connection. + */ +export interface CreateCrossAppAccessResourceApp { + status: Management.CrossAppAccessResourceAppStatusEnum; } export interface CreateCustomDomainResponseContent { @@ -9683,6 +9754,14 @@ export interface CreateHookResponseContent { */ export type CreateHookSecretRequestContent = Record; +/** + * Configuration on the use of ID-JAGs for Cross App Access. + */ +export interface CreateIdentityAssertionAuthorizationGrant { + /** If set to true, the client can exchange ID-JAGs for access tokens. */ + active: boolean; +} + export interface CreateImportUsersResponseContent { /** Status of this job. */ status: string; @@ -10269,6 +10348,21 @@ export interface CrossAppAccessRequestingApp { active: boolean; } +/** + * Cross App Access - Resource App settings that apply to this connection. + */ +export interface CrossAppAccessResourceApp { + status: Management.CrossAppAccessResourceAppStatusEnum; +} + +/** Set to `enabled` to accept ID-JAGs from this connection's identity provider to issue access tokens to other connected applications. */ +export const CrossAppAccessResourceAppStatusEnum = { + Enabled: "enabled", + Disabled: "disabled", +} as const; +export type CrossAppAccessResourceAppStatusEnum = + (typeof CrossAppAccessResourceAppStatusEnum)[keyof typeof CrossAppAccessResourceAppStatusEnum]; + /** * CSP directives map. Keys are directive names, values are arrays of directive values. */ @@ -23529,6 +23623,7 @@ export interface GetBrandingDefaultThemeResponseContent { /** Display Name */ displayName: string; fonts: Management.BrandingThemeFonts; + identifiers?: Management.BrandingThemeIdentifiers | undefined; page_background: Management.BrandingThemePageBackground; /** Theme Id */ themeId: string; @@ -23570,6 +23665,7 @@ export interface GetBrandingThemeResponseContent { /** Display Name */ displayName: string; fonts: Management.BrandingThemeFonts; + identifiers?: Management.BrandingThemeIdentifiers | undefined; page_background: Management.BrandingThemePageBackground; /** Theme Id */ themeId: string; @@ -23744,6 +23840,7 @@ export interface GetClientResponseContent { token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; + identity_assertion_authorization_grant?: Management.IdentityAssertionAuthorizationGrant | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ @@ -23810,6 +23907,7 @@ export interface GetConnectionResponseContent { authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp | undefined; + cross_app_access_resource_app?: Management.CrossAppAccessResourceApp | undefined; } export interface GetCustomDomainResponseContent { @@ -24658,6 +24756,7 @@ export interface GetSessionResponseContent { authentication?: Management.SessionAuthenticationSignals | undefined; cookie?: Management.SessionCookieMetadata | undefined; session_metadata?: ((Management.SessionMetadata | undefined) | null) | undefined; + actor?: Management.SessionActorMetadata | undefined; /** Accepts any additional properties */ [key: string]: any; } @@ -25128,6 +25227,14 @@ export interface Identity { connection_id?: string | undefined; } +/** + * Configuration on the use of ID-JAGs for Cross App Access. + */ +export interface IdentityAssertionAuthorizationGrant { + /** If set to true, the client can exchange ID-JAGs for access tokens. */ + active: boolean; +} + /** Identity provider name of the identity (e.g. `google-oauth2`). */ export const IdentityProviderEnum = { Ad: "ad", @@ -27849,6 +27956,7 @@ export interface RotateClientSecretResponseContent { token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; + identity_assertion_authorization_grant?: Management.IdentityAssertionAuthorizationGrant | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ @@ -28286,6 +28394,19 @@ export interface SelfServiceProfileUserAttribute { */ export type SelfServiceProfileUserAttributes = (Management.SelfServiceProfileUserAttribute[] | null) | undefined; +/** + * Additional property for session actor, can be string, boolean, or number. + */ +export type SessionActorClaimValue = string | boolean | number; + +/** + * The identity of the delegating party/session actor for delegated sessions. Present only on delegated sessions. Contains "sub" and up to 5 additional primitive claims. + */ +export interface SessionActorMetadata { + /** Subject identifier of the actor */ + sub: string; +} + /** * Authentication signal details */ @@ -28403,6 +28524,7 @@ export interface SessionResponseContent { authentication?: Management.SessionAuthenticationSignals | undefined; cookie?: Management.SessionCookieMetadata | undefined; session_metadata?: ((Management.SessionMetadata | undefined) | null) | undefined; + actor?: Management.SessionActorMetadata | undefined; /** Accepts any additional properties */ [key: string]: any; } @@ -29129,6 +29251,14 @@ export interface TestCustomDomainResponseContent { */ export type TestEventDataContent = Record; +/** + * Configuration for Third Party Client Access during the Self-Service Enterprise Configuration flow. + */ +export interface ThirdPartyClientAccessConfig { + /** Whether third-party applications can configure the connection as a domain-level connection during the Self-Service Enterprise Configuration flow. */ + allow_configuration: boolean; +} + export interface TokenExchangeProfileResponseContent { /** The unique ID of the token exchange profile. */ id?: string | undefined; @@ -29407,6 +29537,7 @@ export interface UpdateBrandingThemeResponseContent { /** Display Name */ displayName: string; fonts: Management.BrandingThemeFonts; + identifiers?: Management.BrandingThemeIdentifiers | undefined; page_background: Management.BrandingThemePageBackground; /** Theme Id */ themeId: string; @@ -29558,6 +29689,7 @@ export interface UpdateClientResponseContent { token_quota?: Management.TokenQuota | undefined; express_configuration?: Management.ExpressConfiguration | undefined; my_organization_configuration?: Management.ClientMyOrganizationResponseConfiguration | undefined; + identity_assertion_authorization_grant?: Management.IdentityAssertionAuthorizationGrant | undefined; third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum | undefined; redirection_policy?: Management.ClientRedirectionPolicyEnum | undefined; /** The identifier of the resource server that this client is linked to. */ @@ -29864,6 +29996,7 @@ export interface UpdateConnectionRequestContentOidc extends Management.Connectio authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurposeXaa | undefined; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp | undefined; + cross_app_access_resource_app?: (Management.ConnectionCrossAppAccessResourceApp | null) | undefined; show_as_button?: Management.ConnectionShowAsButton | undefined; } @@ -30064,6 +30197,14 @@ export interface UpdateConnectionResponseContent { authentication?: Management.ConnectionAuthenticationPurpose | undefined; connected_accounts?: Management.ConnectionConnectedAccountsPurpose | undefined; cross_app_access_requesting_app?: Management.CrossAppAccessRequestingApp | undefined; + cross_app_access_resource_app?: Management.CrossAppAccessResourceApp | undefined; +} + +/** + * Cross App Access - Resource App settings that apply to this connection. + */ +export interface UpdateCrossAppAccessResourceApp { + status: Management.CrossAppAccessResourceAppStatusEnum; } export interface UpdateCustomDomainResponseContent { @@ -30309,6 +30450,14 @@ export interface UpdateHookResponseContent { */ export type UpdateHookSecretRequestContent = Record; +/** + * Configuration on the use of ID-JAGs for Cross App Access. + */ +export interface UpdateIdentityAssertionAuthorizationGrant { + /** If set to true, the client can exchange ID-JAGs for access tokens. */ + active: boolean; +} + export type UpdateLogStreamResponseContent = | Management.LogStreamHttpResponseSchema | Management.LogStreamEventBridgeResponseSchema @@ -30567,6 +30716,7 @@ export interface UpdateSessionResponseContent { authentication?: Management.SessionAuthenticationSignals | undefined; cookie?: Management.SessionCookieMetadata | undefined; session_metadata?: ((Management.SessionMetadata | undefined) | null) | undefined; + actor?: Management.SessionActorMetadata | undefined; /** Accepts any additional properties */ [key: string]: any; } diff --git a/src/management/tests/wire/branding/themes.test.ts b/src/management/tests/wire/branding/themes.test.ts index 537145d254..08e7475e3d 100644 --- a/src/management/tests/wire/branding/themes.test.ts +++ b/src/management/tests/wire/branding/themes.test.ts @@ -108,6 +108,11 @@ describe("ThemesClient", () => { subtitle: { bold: true, size: 1.1 }, title: { bold: true, size: 1.1 }, }, + identifiers: { + login_display: "separate", + otp_autocomplete: true, + phone_display: { formatting: "international", masking: "hide_country_code" }, + }, page_background: { background_color: "background_color", background_image_url: "background_image_url", @@ -977,6 +982,11 @@ describe("ThemesClient", () => { subtitle: { bold: true, size: 1.1 }, title: { bold: true, size: 1.1 }, }, + identifiers: { + login_display: "separate", + otp_autocomplete: true, + phone_display: { formatting: "international", masking: "hide_country_code" }, + }, page_background: { background_color: "background_color", background_image_url: "background_image_url", @@ -1130,6 +1140,11 @@ describe("ThemesClient", () => { subtitle: { bold: true, size: 1.1 }, title: { bold: true, size: 1.1 }, }, + identifiers: { + login_display: "separate", + otp_autocomplete: true, + phone_display: { formatting: "international", masking: "hide_country_code" }, + }, page_background: { background_color: "background_color", background_image_url: "background_image_url", @@ -1422,6 +1437,11 @@ describe("ThemesClient", () => { subtitle: { bold: true, size: 1.1 }, title: { bold: true, size: 1.1 }, }, + identifiers: { + login_display: "separate", + otp_autocomplete: true, + phone_display: { formatting: "international", masking: "hide_country_code" }, + }, page_background: { background_color: "background_color", background_image_url: "background_image_url", diff --git a/src/management/tests/wire/clients.test.ts b/src/management/tests/wire/clients.test.ts index 72df34cdb7..f44dd6c942 100644 --- a/src/management/tests/wire/clients.test.ts +++ b/src/management/tests/wire/clients.test.ts @@ -70,6 +70,7 @@ describe("ClientsClient", () => { allowed_strategies: ["pingfederate"], connection_deletion_behavior: "allow", }, + identity_assertion_authorization_grant: { active: true }, third_party_security_mode: "strict", redirection_policy: "allow_always", resource_server_identifier: "resource_server_identifier", @@ -393,6 +394,7 @@ describe("ClientsClient", () => { connection_deletion_behavior: "allow", invitation_landing_client_id: "invitation_landing_client_id", }, + identity_assertion_authorization_grant: { active: true }, third_party_security_mode: "strict", redirection_policy: "allow_always", resource_server_identifier: "resource_server_identifier", @@ -1054,6 +1056,7 @@ describe("ClientsClient", () => { connection_deletion_behavior: "allow", invitation_landing_client_id: "invitation_landing_client_id", }, + identity_assertion_authorization_grant: { active: true }, third_party_security_mode: "strict", redirection_policy: "allow_always", resource_server_identifier: "resource_server_identifier", @@ -1407,6 +1410,7 @@ describe("ClientsClient", () => { connection_deletion_behavior: "allow", invitation_landing_client_id: "invitation_landing_client_id", }, + identity_assertion_authorization_grant: { active: true }, third_party_security_mode: "strict", redirection_policy: "allow_always", resource_server_identifier: "resource_server_identifier", @@ -1737,6 +1741,7 @@ describe("ClientsClient", () => { connection_deletion_behavior: "allow", invitation_landing_client_id: "invitation_landing_client_id", }, + identity_assertion_authorization_grant: { active: true }, third_party_security_mode: "strict", redirection_policy: "allow_always", resource_server_identifier: "resource_server_identifier", diff --git a/src/management/tests/wire/clients/connections.test.ts b/src/management/tests/wire/clients/connections.test.ts index bc673dd956..b6c647ead8 100644 --- a/src/management/tests/wire/clients/connections.test.ts +++ b/src/management/tests/wire/clients/connections.test.ts @@ -23,6 +23,7 @@ describe("ConnectionsClient", () => { authentication: { active: true }, connected_accounts: { active: true }, cross_app_access_requesting_app: { active: true }, + cross_app_access_resource_app: { status: "enabled" }, }, ], next: "next", diff --git a/src/management/tests/wire/connections.test.ts b/src/management/tests/wire/connections.test.ts index 15729b2162..61be0b06ba 100644 --- a/src/management/tests/wire/connections.test.ts +++ b/src/management/tests/wire/connections.test.ts @@ -24,6 +24,7 @@ describe("ConnectionsClient", () => { authentication: { active: true }, connected_accounts: { active: true }, cross_app_access_requesting_app: { active: true }, + cross_app_access_resource_app: { status: "enabled" }, }, ], }; @@ -122,6 +123,7 @@ describe("ConnectionsClient", () => { authentication: { active: true }, connected_accounts: { active: true, cross_app_access: true }, cross_app_access_requesting_app: { active: true }, + cross_app_access_resource_app: { status: "enabled" }, }; server @@ -273,6 +275,7 @@ describe("ConnectionsClient", () => { authentication: { active: true }, connected_accounts: { active: true, cross_app_access: true }, cross_app_access_requesting_app: { active: true }, + cross_app_access_resource_app: { status: "enabled" }, }; server.mockEndpoint().get("/connections/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); @@ -429,6 +432,7 @@ describe("ConnectionsClient", () => { authentication: { active: true }, connected_accounts: { active: true, cross_app_access: true }, cross_app_access_requesting_app: { active: true }, + cross_app_access_resource_app: { status: "enabled" }, }; server diff --git a/src/management/tests/wire/sessions.test.ts b/src/management/tests/wire/sessions.test.ts index 4bc976b9bb..b933a11008 100644 --- a/src/management/tests/wire/sessions.test.ts +++ b/src/management/tests/wire/sessions.test.ts @@ -30,6 +30,7 @@ describe("SessionsClient", () => { authentication: { methods: [{}] }, cookie: { mode: "non-persistent" }, session_metadata: { key: "value" }, + actor: { sub: "sub" }, }; server.mockEndpoint().get("/sessions/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); @@ -177,6 +178,7 @@ describe("SessionsClient", () => { authentication: { methods: [{}] }, cookie: { mode: "non-persistent" }, session_metadata: { key: "value" }, + actor: { sub: "sub" }, }; server diff --git a/src/management/tests/wire/users/sessions.test.ts b/src/management/tests/wire/users/sessions.test.ts index 3007b61a8f..cb20bc1887 100644 --- a/src/management/tests/wire/users/sessions.test.ts +++ b/src/management/tests/wire/users/sessions.test.ts @@ -22,6 +22,7 @@ describe("SessionsClient", () => { last_interacted_at: "2024-01-15T09:30:00Z", clients: [{}], session_metadata: { key: "value" }, + actor: { sub: "sub" }, }, ], next: "next", diff --git a/src/management/version.ts b/src/management/version.ts index f59346832d..7ba3a938b0 100644 --- a/src/management/version.ts +++ b/src/management/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "5.14.0"; +export const SDK_VERSION = "6.0.0"; diff --git a/v6_MIGRATION_GUIDE.md b/v6_MIGRATION_GUIDE.md deleted file mode 100644 index d1eb6bd699..0000000000 --- a/v6_MIGRATION_GUIDE.md +++ /dev/null @@ -1,158 +0,0 @@ -# V6 Migration Guide - -A guide to migrating the Auth0 Node.js SDK from `5.x` to `6.x`. - -- [Overall changes](#overall-changes) -- [Breaking changes](#breaking-changes) - - [ConnectionAttributeIdentifier replaced with identifier-specific types](#connectionattributeidentifier-replaced-with-identifier-specific-types) - - [PhoneProviderProtectionBackoffStrategyEnum value change](#phoneproviderprotectionbackoffstrategyenum-value-change) - - [users.federatedConnectionsTokensets removed](#usersfederatedconnectionstokensets-removed) - - [federated_connections_access_tokens removed from connection options](#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: - -| Attribute | Old type | New type | `default_method` values | -| -------------- | ------------------------------- | ----------------------------- | ----------------------------- | -| `email` | `ConnectionAttributeIdentifier` | `EmailAttributeIdentifier` | `"password"` \| `"email_otp"` | -| `phone_number` | `ConnectionAttributeIdentifier` | `PhoneAttributeIdentifier` | `"password"` \| `"phone_otp"` | -| `username` | `ConnectionAttributeIdentifier` | `UsernameAttributeIdentifier` | _(no `default_method`)_ | - -**Before (v5):** - -```ts -import { Management } from "auth0"; - -const identifier: Management.ConnectionAttributeIdentifier = { - active: true, - default_method: "email_otp", -}; -``` - -**After (v6):** - -```ts -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):** - -```ts -import { Management } from "auth0"; - -const strategy = Management.PhoneProviderProtectionBackoffStrategyEnum.None; // "none" -``` - -**After (v6):** - -```ts -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):** - -```ts -// 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):** - -```ts -// 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):** - -```ts -// 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 - }, -}); -``` diff --git a/yarn.lock b/yarn.lock index 3764c557ab..0baacccdb1 100644 --- a/yarn.lock +++ b/yarn.lock @@ -771,9 +771,9 @@ integrity sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg== "@sinclair/typebox@^0.27.8": - version "0.27.10" - resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.10.tgz#beefe675f1853f73676aecc915b2bd2ac98c4fc6" - integrity sha512-MTBk/3jGLNB2tVxv6uLlFh1iu64iYOQ2PbdOSK3NW8JZsmlaOh2q6sdtKowBhfw8QFLmYNzTW4/oK4uATIi6ZA== + version "0.27.12" + resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.12.tgz#0cacd3cff047a32936b1ace47ea7c86eaab60a7f" + integrity sha512-hhyNJ+nbR6ZR7pToHvllEFun9TL0sbL+tk/ON75lo+Xas054uez98qRbsuNt7MBCyZKK4+8Yli/OAGZhmfBZ/g== "@sinonjs/commons@^3.0.0": version "3.0.1" @@ -939,99 +939,99 @@ "@types/yargs-parser" "*" "@typescript-eslint/eslint-plugin@^8.38.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.64.0.tgz#71a0c3d5f8a5e6c5dfdb4f0f04bd1bfb572d5e24" - integrity sha512-CGvQPBxN3wZLu6Rz2kFUpZeoCm78xUic92ck39KPePkO1NPOwjCqdQnm5Q87tpWw9vcBvW8XLrDXjH9PWYtJ3Q== + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.65.0.tgz#0a58df6fea8c0bf6b396f518077099bc8b762bb5" + integrity sha512-IEgob78X12rHpUmtcwFsXhZdVGJtwTVP8FiCLZkR6GlYVrl2PcuB+KhCE5BlVC/eQpQnu8WXRtkHZuPar+gCRA== dependencies: "@eslint-community/regexpp" "^4.12.2" - "@typescript-eslint/scope-manager" "8.64.0" - "@typescript-eslint/type-utils" "8.64.0" - "@typescript-eslint/utils" "8.64.0" - "@typescript-eslint/visitor-keys" "8.64.0" + "@typescript-eslint/scope-manager" "8.65.0" + "@typescript-eslint/type-utils" "8.65.0" + "@typescript-eslint/utils" "8.65.0" + "@typescript-eslint/visitor-keys" "8.65.0" ignore "^7.0.5" natural-compare "^1.4.0" ts-api-utils "^2.5.0" "@typescript-eslint/parser@^8.38.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.64.0.tgz#c9864a1cc28a13ff29a7314fbdef0528bb122f72" - integrity sha512-KA0OshtlcCCXmbfqyZkM5pV3/WNraJf7DkJRLpyrmwPtud57H5BDX7C3k0LPSPxpprfRL+cJDGabF10mvNCoCw== - dependencies: - "@typescript-eslint/scope-manager" "8.64.0" - "@typescript-eslint/types" "8.64.0" - "@typescript-eslint/typescript-estree" "8.64.0" - "@typescript-eslint/visitor-keys" "8.64.0" + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.65.0.tgz#5295c1058c0a1dd746ef28baaf9c0341dbdf03dc" + integrity sha512-CZ4nMxWwgu1HEEFNkeaCptra9QCtkmKdgf3sWh1rl1trIhmxLilgTV4cwcbQ4wemnT4sWQN8CaKOmdYx+g2gMA== + dependencies: + "@typescript-eslint/scope-manager" "8.65.0" + "@typescript-eslint/types" "8.65.0" + "@typescript-eslint/typescript-estree" "8.65.0" + "@typescript-eslint/visitor-keys" "8.65.0" debug "^4.4.3" -"@typescript-eslint/project-service@8.64.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.64.0.tgz#14c4e29390d7325a7f8a1218c2788fd649b85da6" - integrity sha512-tk4WpOJ6IEbGrVHaNmM0YRrwAD3exZlIK3iadQNAxh4YKk6jvUQ4ecq18n+v7+meh+cJ3j+D8nbk8sRKhlwLQg== +"@typescript-eslint/project-service@8.65.0": + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.65.0.tgz#65fbbc9a1591abffaeab5513200f848271cb0aa5" + integrity sha512-SxnPhbTsGahizDgbu7oqFH/xVtzIqMd/s+WtnSxNxJZJpLbdT5IPdzg8EZxO3+PoKahXmwJLeNQOpKJb3/bi7Q== dependencies: - "@typescript-eslint/tsconfig-utils" "^8.64.0" - "@typescript-eslint/types" "^8.64.0" + "@typescript-eslint/tsconfig-utils" "^8.65.0" + "@typescript-eslint/types" "^8.65.0" debug "^4.4.3" -"@typescript-eslint/scope-manager@8.64.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.64.0.tgz#d45f15304a94c85c39db317b717b158fb6259958" - integrity sha512-CXEaFdYXjSTgKhisNkwCcJwTP8Pl+fmRrEQrri4nm3vU743bALrxzLmq7fHG/7e6a5xO0lDYeURpZmBuhHk54w== +"@typescript-eslint/scope-manager@8.65.0": + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.65.0.tgz#9547202ce7e608e7b6283df585703b980a0ea70d" + integrity sha512-Esbl8OSYiVxBokYgWPf7VVWg/BE798wXhimnn9ML9Pt5qoDf8bfQlgjlKXR/k98+AcNzlLKYrpCcrcuZ9DZLgg== dependencies: - "@typescript-eslint/types" "8.64.0" - "@typescript-eslint/visitor-keys" "8.64.0" + "@typescript-eslint/types" "8.65.0" + "@typescript-eslint/visitor-keys" "8.65.0" -"@typescript-eslint/tsconfig-utils@8.64.0", "@typescript-eslint/tsconfig-utils@^8.64.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.64.0.tgz#c62ac8ea9173c3cac8b38b8e66e30a046b548851" - integrity sha512-2yo8rRNKuzbVWQp5kslhANqZ2uDAeROQHBRZNPu8JDsHmeFNj/XJJhX/FhNUWmkHHvoNsKa6+tHJiig87EzsQw== +"@typescript-eslint/tsconfig-utils@8.65.0", "@typescript-eslint/tsconfig-utils@^8.65.0": + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.65.0.tgz#36f168fcdbb1295f7446ff0379667f98c3cf1bf3" + integrity sha512-j6GzGqCiRdA7Qhur2VVmKZAkBLfnHFQfx4TaJGL9RMveZqCo48jSHHO0DTgizEnGhtWnqmbtCUSrqSkdiY/0Hg== -"@typescript-eslint/type-utils@8.64.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-8.64.0.tgz#106fa7d58cf9cf7758f3dd8e426ac8237eceacf3" - integrity sha512-XWG4Fmmv/6SvyS9nH8jWrKs6terwJvE8cyRt1CzYYqzp9OrPhCT4cMc/f7C6RZCwG+qMmiffJS1/qJP8G1URtg== +"@typescript-eslint/type-utils@8.65.0": + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-8.65.0.tgz#d316d7522d93cff4cd14f305e02f3df2d804f9c1" + integrity sha512-YjaZ7PRI5qY7ax2L3PbvX0rRyGtipAReCWs0mhhDBHjH/vl0g0BonaGXrKdKpMbIIsMIwDgbk/xzkBTyAltS5g== dependencies: - "@typescript-eslint/types" "8.64.0" - "@typescript-eslint/typescript-estree" "8.64.0" - "@typescript-eslint/utils" "8.64.0" + "@typescript-eslint/types" "8.65.0" + "@typescript-eslint/typescript-estree" "8.65.0" + "@typescript-eslint/utils" "8.65.0" debug "^4.4.3" ts-api-utils "^2.5.0" -"@typescript-eslint/types@8.64.0", "@typescript-eslint/types@^8.64.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.64.0.tgz#b41f8ef5dd40616908658b991197a9d486cda60b" - integrity sha512-qjhfuTfLXjA4IOzXvz0rTjT01BqEiIgPoUeMwiEjnaHKJMTNo8rH5pYW1a2L/0Dnux2fPC85AeyJoWaGa8WxTA== +"@typescript-eslint/types@8.65.0", "@typescript-eslint/types@^8.65.0": + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.65.0.tgz#3e86738416a777c8b8925ab46745f48ecf904c9f" + integrity sha512-JSSwWNy+H0E/01jJEM+hrX6N0OFDzFzeIhHFSAS01tlVaevpG8cFyYRPhS5yjGOvBUx3sqQHVMjCL1CAZZMxBg== -"@typescript-eslint/typescript-estree@8.64.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.64.0.tgz#b8d51255e2d726eb4bd80d397a4fb4170c02eecc" - integrity sha512-Pztpsn1aCE1oWDvDEfUk31nngvvF7vUB5SwHFEaZIFpvw7WJtqUHHL4plBZDA9HfWJJjL13BdG0YrJInTUvoVA== +"@typescript-eslint/typescript-estree@8.65.0": + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.65.0.tgz#f1f514808f6aa713e2d678ae8ff592a65e1632af" + integrity sha512-JboAE2swaYt4tb1fHhHTABE2K+OLy09XfcTbhnk4Pw96f9dd2e9iYsJ28gBggHlo5z5x1rkyWvcPoTuNTd4oGg== dependencies: - "@typescript-eslint/project-service" "8.64.0" - "@typescript-eslint/tsconfig-utils" "8.64.0" - "@typescript-eslint/types" "8.64.0" - "@typescript-eslint/visitor-keys" "8.64.0" + "@typescript-eslint/project-service" "8.65.0" + "@typescript-eslint/tsconfig-utils" "8.65.0" + "@typescript-eslint/types" "8.65.0" + "@typescript-eslint/visitor-keys" "8.65.0" debug "^4.4.3" minimatch "^10.2.2" semver "^7.7.3" tinyglobby "^0.2.15" ts-api-utils "^2.5.0" -"@typescript-eslint/utils@8.64.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.64.0.tgz#98bb2010cfb754b41985b9c93e6e8b3dcd7bd600" - integrity sha512-aJUGVB3+U0htrrCjoA8qukw8cm8fNCGAxK/tVoS70k8aeb7DETKeFozRiVFIwEeN9WJLsjaP3ph8I60tY2XZoQ== +"@typescript-eslint/utils@8.65.0": + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.65.0.tgz#afedd974a0c8deeef553b509df5800bafd615a72" + integrity sha512-gXiwIHsYreboxeJucHKPvgwl7dXt50mF8s1/c00cP/WoVTyWKFdtfhRWwZiXYFU5H2O8vVoSLNrexFZjYS/SGA== dependencies: "@eslint-community/eslint-utils" "^4.9.1" - "@typescript-eslint/scope-manager" "8.64.0" - "@typescript-eslint/types" "8.64.0" - "@typescript-eslint/typescript-estree" "8.64.0" + "@typescript-eslint/scope-manager" "8.65.0" + "@typescript-eslint/types" "8.65.0" + "@typescript-eslint/typescript-estree" "8.65.0" -"@typescript-eslint/visitor-keys@8.64.0": - version "8.64.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.64.0.tgz#7a08421d10e54960733352cd7c95fab1784e8473" - integrity sha512-mrtuL8Nsn6gi2H4mo5KMTp823M+3Q19Ew/i+Zlikq20tIMm99C3Ez0dCmkWWnxut20esQvTg8aUSEhMcAOXhEw== +"@typescript-eslint/visitor-keys@8.65.0": + version "8.65.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.65.0.tgz#e3704c13cb4a1c22454c1abf28ff4737e15018c6" + integrity sha512-8C71BQkGjiMmXtop7pHVJu1l2NNShFdkCyD6a2ezzs5vU/L3LRtb69EtcteFwz0mYMPzIgOw0n6OV4VBUWZd7A== dependencies: - "@typescript-eslint/types" "8.64.0" + "@typescript-eslint/types" "8.65.0" eslint-visitor-keys "^5.0.0" "@webassemblyjs/ast@1.14.1", "@webassemblyjs/ast@^1.14.1": @@ -1390,9 +1390,9 @@ balanced-match@^4.0.2: integrity sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA== baseline-browser-mapping@^2.10.42: - version "2.10.43" - resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.10.43.tgz#7b5d11590ce5acdbe4859443e3c940e81ce8c02d" - integrity sha512-AjYpR78kDWAY3Efj+cDTFH9t9SCoL7OoTp1BOb0mQV7S+6CiLwnWM3FyxhJtdPufDFKzmCSFoUncKjWgJEZTCQ== + version "2.10.44" + resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.10.44.tgz#2e074675e640b67cb3835c54c11aa2dd9119c0f8" + integrity sha512-T3ghW+sl/ZJ8w1v/yQx3qvJ9040DWoLBz8JT/CILbAKcFyG9b2MRe75v6W5uXjv6uH1lumK2Kv46y2zSkcej0Q== brace-expansion@^1.1.7: version "1.1.16" @@ -1470,9 +1470,9 @@ camelcase@^6.2.0: integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== caniuse-lite@^1.0.30001803: - version "1.0.30001805" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001805.tgz#78d5d5968a69b7ff81af87a96d7ddc7ea6670b1e" - integrity sha512-52noaS3DubycKSXaU30TwPGIp+POyQSUVa5jBEq3vkRkY0kjyb3LQgvhU6WGyCcyXqVLWO0Cw0Q6BSdD0kUfVA== + version "1.0.30001806" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001806.tgz#1bc8e502b723fa393455dfbedd5ccec0c29bb74e" + integrity sha512-72Cuvd95zbSYPKq6Fhg8eDJRlzgWDf7/mtoZv6Qe/DYNCEBdNxoA3+rZAU2ZhGCpZlns3EssFavaZomckT5Uuw== chalk@^4.0.0, chalk@^4.1.0: version "4.1.2" @@ -1697,9 +1697,9 @@ dunder-proto@^1.0.1: gopd "^1.2.0" electron-to-chromium@^1.5.389: - version "1.5.392" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.392.tgz#31e9f9af0d8df3d1489468a4242b173605617482" - integrity sha512-1yQq3VQCZRwsnYc67Oc+1fge6Lwtn0hzi6zmEVkB61Zx21kTbwJAW4dFLadl5Rc1tKhG/kSpYXnfiAhu0f0a1g== + version "1.5.394" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.394.tgz#1b7eaf1abbeabaced7ce401705ec7cc488fd492b" + integrity sha512-Wmt2Gm0o8JWBuGgmc4XZ0u9s1RaCRqhxP47phplmfg04+qypTUurpeJGP45A7Fhv7jdrrVH44PLlR9qXo37cVQ== emittery@^0.13.1: version "0.13.1" @@ -1717,9 +1717,9 @@ emoji-regex@^8.0.0: integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== enhanced-resolve@^5.22.2: - version "5.24.2" - resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.24.2.tgz#f25d703a24431cb1e02f944adb74aefa4fcb8d7e" - integrity sha512-rpsZEGT1jFuve6QlpyRp9ckQ+kN61hvF9BzCPyMdaKTm8UJce96KBn3sorXOFXlzjPrs3Vc4T1NsSroZ3PxlFw== + version "5.24.3" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.24.3.tgz#406bbf1ec20971265a30254f08030fce6a8207fe" + integrity sha512-PwKooW9JUzh5chmYfHM3IQl5OkK2u2Nm011MgeZrss3JmFraUx/fqrf78kk8GUMYoibx/14MdwTl/1WKkG7TpQ== dependencies: graceful-fs "^4.2.4" tapable "^2.3.3" @@ -1993,9 +1993,9 @@ fast-levenshtein@^2.0.6: integrity sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw== fast-uri@^3.0.1: - version "3.1.3" - resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.3.tgz#f695a40f006aba505631573a0021ddb21194ad11" - integrity sha512-i70LwGWUduXqzicKXWshooq+sWL1K3WUU5rKZNG/0i3a1OSoX3HqhH5WbWwTmqWfor4urUakGPiRQcleRZTwOg== + version "3.1.4" + resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.4.tgz#3b3daf9ce68f41f956df0b505132c0cfce9ec7af" + integrity sha512-8JnbkQ4juDyvYs4mgFGQqg4yCYtFDtUtmp2QIQq11ZZe5CFQ5wcqm1rqDgAh/QdMySuBnPzMUiJUNZG5N/AiQw== fb-watchman@^2.0.0: version "2.0.2" @@ -3777,17 +3777,17 @@ tinyglobby@^0.2.15: fdir "^6.5.0" picomatch "^4.0.4" -tldts-core@^7.4.8: - version "7.4.8" - resolved "https://registry.yarnpkg.com/tldts-core/-/tldts-core-7.4.8.tgz#c729aee4ff9d3670741193682a98e25a3d780dd9" - integrity sha512-c1P7u0EhACHj7lPy4MJm8iTFEU8+nB0LCtddH0fhP7noaVoXAqafMtOOeX+ulpuPBqnrRgRhw494RICT3mbhnw== +tldts-core@^7.4.9: + version "7.4.9" + resolved "https://registry.yarnpkg.com/tldts-core/-/tldts-core-7.4.9.tgz#8c3e6fc36123b6001290860d2abda6546466980b" + integrity sha512-DxKfPBI52p2msTEu7MPhdpdDTBhhVQg1a/8PjQckeyAvO13eMYElX545grIp6nnTGIMZlRvFZPvFhvI/WIz2Vg== tldts@^7.0.5: - version "7.4.8" - resolved "https://registry.yarnpkg.com/tldts/-/tldts-7.4.8.tgz#f2edc0d81483ea76c45827d642ccd535a3a7a4f7" - integrity sha512-htwgN/8KRB3z3vnC0BOETVh2m499g5GmyTK9Wq5JBLX3FNz6tSBveAd+fQhzy9hkjif8vy2jwDMR1sGhLtZl2A== + version "7.4.9" + resolved "https://registry.yarnpkg.com/tldts/-/tldts-7.4.9.tgz#78e72ad3c68fc1ec0626e6528f259dd5307a2629" + integrity sha512-3kZ8wQQ/k5DrChD4X4FVvr2D7E5uoRgAqkPyLpSCGUvqOvqu+JEdr3mwMUaVWb+vMHZaKhF5fp2PBigKsui7hA== dependencies: - tldts-core "^7.4.8" + tldts-core "^7.4.9" tmpl@1.0.5: version "1.0.5" From cda260bef2cdfefa49d1f5323340b3d6f3e5bfa1 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Tue, 21 Jul 2026 07:20:03 +0000 Subject: [PATCH 2/2] [fern-replay] Applied customizations Patches applied (2): - patch-066ff9e0: docs: add v6 migration guide for breaking changes in v6.0.0 (#1368) - patch-d8faf7a2: docs: update v6 migration guide with federatedConnectionsTokensets and federated_connections_access_tokens breaking changes (#1370) Patches absorbed by generator (1): - patch-a823058b: Release v6.0.0 (#1371) The generator now produces these customizations natively. --- .fern/replay.lock | 497 +++++++++++++++++++++++++++++++++++++++++- v6_MIGRATION_GUIDE.md | 158 ++++++++++++++ 2 files changed, 648 insertions(+), 7 deletions(-) create mode 100644 v6_MIGRATION_GUIDE.md diff --git a/.fern/replay.lock b/.fern/replay.lock index 4ec0cc681c..e7d4ca193b 100644 --- a/.fern/replay.lock +++ b/.fern/replay.lock @@ -12,23 +12,29 @@ generations: cli_version: unknown generator_versions: fernapi/fern-typescript-sdk: 3.72.5 -current_generation: 2de4c6369e279ba461d20dfe1bb8503255fab5a6 + - commit_sha: 976f3421bba0cc2818dfeaede922ab57e8dbab20 + tree_hash: 65d9f2e949797e3752e9874d498f478e96ea233c + timestamp: 2026-07-21T07:19:56.058Z + cli_version: unknown + generator_versions: + fernapi/fern-typescript-sdk: 3.72.5 +current_generation: 976f3421bba0cc2818dfeaede922ab57e8dbab20 patches: - id: patch-066ff9e0 - content_hash: sha256:d30e29e02d93b301c7d7f14434c3339c9008aa98a07e6d5a4d6f3e2b06e9e51b + content_hash: sha256:5b87ec9a63fc57aba4840d0d335d472c621e838fc1d61515b30660df39d0dbc2 original_commit: 066ff9e02c45f4abf46791a3f070c762f7ecd924 original_message: "docs: add v6 migration guide for breaking changes in v6.0.0 (#1368)" original_author: Ankita Tripathi <51994119+ankita10119@users.noreply.github.com> - base_generation: 2de4c6369e279ba461d20dfe1bb8503255fab5a6 + base_generation: 976f3421bba0cc2818dfeaede922ab57e8dbab20 files: - v6_MIGRATION_GUIDE.md patch_content: | diff --git a/v6_MIGRATION_GUIDE.md b/v6_MIGRATION_GUIDE.md new file mode 100644 - index 000000000..30d5944c4 + index 000000000..d1eb6bd69 --- /dev/null +++ b/v6_MIGRATION_GUIDE.md - @@ -0,0 +1,86 @@ + @@ -0,0 +1,158 @@ +# V6 Migration Guide + +A guide to migrating the Auth0 Node.js SDK from `5.x` to `6.x`. @@ -37,10 +43,12 @@ patches: +- [Breaking changes](#breaking-changes) + - [ConnectionAttributeIdentifier replaced with identifier-specific types](#connectionattributeidentifier-replaced-with-identifier-specific-types) + - [PhoneProviderProtectionBackoffStrategyEnum value change](#phoneproviderprotectionbackoffstrategyenum-value-change) + + - [users.federatedConnectionsTokensets removed](#usersfederatedconnectionstokensets-removed) + + - [federated_connections_access_tokens removed from connection options](#federated_connections_access_tokens-removed-from-connection-options) + +## Overall changes + - +V6 is a focused release that addresses type correctness for database connection attribute identifiers and aligns the phone provider backoff strategy enum with the updated API. 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`. + +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 + @@ -115,6 +123,76 @@ patches: +``` + +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):** + + + +```ts + +// 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):** + + + +```ts + +// 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):** + + + +```ts + +// 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 + + }, + +}); + +``` theirs_snapshot: v6_MIGRATION_GUIDE.md: | # V6 Migration Guide @@ -125,10 +203,12 @@ patches: - [Breaking changes](#breaking-changes) - [ConnectionAttributeIdentifier replaced with identifier-specific types](#connectionattributeidentifier-replaced-with-identifier-specific-types) - [PhoneProviderProtectionBackoffStrategyEnum value change](#phoneproviderprotectionbackoffstrategyenum-value-change) + - [users.federatedConnectionsTokensets removed](#usersfederatedconnectionstokensets-removed) + - [federated_connections_access_tokens removed from connection options](#federated_connections_access_tokens-removed-from-connection-options) ## Overall changes - V6 is a focused release that addresses type correctness for database connection attribute identifiers and aligns the phone provider backoff strategy enum with the updated API. 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`. + 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 @@ -203,4 +283,407 @@ patches: ``` 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):** + + ```ts + // 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):** + + ```ts + // 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):** + + ```ts + // 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 + }, + }); + ``` user_owned: true + - id: patch-d8faf7a2 + content_hash: sha256:5b87ec9a63fc57aba4840d0d335d472c621e838fc1d61515b30660df39d0dbc2 + original_commit: d8faf7a21efbed3bd75a0f36ff0d190bb9dd986b + original_message: "docs: update v6 migration guide with federatedConnectionsTokensets and federated_connections_access_tokens breaking changes (#1370)" + original_author: Ankita Tripathi <51994119+ankita10119@users.noreply.github.com> + base_generation: 976f3421bba0cc2818dfeaede922ab57e8dbab20 + files: + - v6_MIGRATION_GUIDE.md + patch_content: | + diff --git a/v6_MIGRATION_GUIDE.md b/v6_MIGRATION_GUIDE.md + new file mode 100644 + index 000000000..d1eb6bd69 + --- /dev/null + +++ b/v6_MIGRATION_GUIDE.md + @@ -0,0 +1,158 @@ + +# V6 Migration Guide + + + +A guide to migrating the Auth0 Node.js SDK from `5.x` to `6.x`. + + + +- [Overall changes](#overall-changes) + +- [Breaking changes](#breaking-changes) + + - [ConnectionAttributeIdentifier replaced with identifier-specific types](#connectionattributeidentifier-replaced-with-identifier-specific-types) + + - [PhoneProviderProtectionBackoffStrategyEnum value change](#phoneproviderprotectionbackoffstrategyenum-value-change) + + - [users.federatedConnectionsTokensets removed](#usersfederatedconnectionstokensets-removed) + + - [federated_connections_access_tokens removed from connection options](#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: + + + +| Attribute | Old type | New type | `default_method` values | + +| -------------- | ------------------------------- | ----------------------------- | ----------------------------- | + +| `email` | `ConnectionAttributeIdentifier` | `EmailAttributeIdentifier` | `"password"` \| `"email_otp"` | + +| `phone_number` | `ConnectionAttributeIdentifier` | `PhoneAttributeIdentifier` | `"password"` \| `"phone_otp"` | + +| `username` | `ConnectionAttributeIdentifier` | `UsernameAttributeIdentifier` | _(no `default_method`)_ | + + + +**Before (v5):** + + + +```ts + +import { Management } from "auth0"; + + + +const identifier: Management.ConnectionAttributeIdentifier = { + + active: true, + + default_method: "email_otp", + +}; + +``` + + + +**After (v6):** + + + +```ts + +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):** + + + +```ts + +import { Management } from "auth0"; + + + +const strategy = Management.PhoneProviderProtectionBackoffStrategyEnum.None; // "none" + +``` + + + +**After (v6):** + + + +```ts + +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):** + + + +```ts + +// 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):** + + + +```ts + +// 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):** + + + +```ts + +// 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 + + }, + +}); + +``` + theirs_snapshot: + v6_MIGRATION_GUIDE.md: | + # V6 Migration Guide + + A guide to migrating the Auth0 Node.js SDK from `5.x` to `6.x`. + + - [Overall changes](#overall-changes) + - [Breaking changes](#breaking-changes) + - [ConnectionAttributeIdentifier replaced with identifier-specific types](#connectionattributeidentifier-replaced-with-identifier-specific-types) + - [PhoneProviderProtectionBackoffStrategyEnum value change](#phoneproviderprotectionbackoffstrategyenum-value-change) + - [users.federatedConnectionsTokensets removed](#usersfederatedconnectionstokensets-removed) + - [federated_connections_access_tokens removed from connection options](#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: + + | Attribute | Old type | New type | `default_method` values | + | -------------- | ------------------------------- | ----------------------------- | ----------------------------- | + | `email` | `ConnectionAttributeIdentifier` | `EmailAttributeIdentifier` | `"password"` \| `"email_otp"` | + | `phone_number` | `ConnectionAttributeIdentifier` | `PhoneAttributeIdentifier` | `"password"` \| `"phone_otp"` | + | `username` | `ConnectionAttributeIdentifier` | `UsernameAttributeIdentifier` | _(no `default_method`)_ | + + **Before (v5):** + + ```ts + import { Management } from "auth0"; + + const identifier: Management.ConnectionAttributeIdentifier = { + active: true, + default_method: "email_otp", + }; + ``` + + **After (v6):** + + ```ts + 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):** + + ```ts + import { Management } from "auth0"; + + const strategy = Management.PhoneProviderProtectionBackoffStrategyEnum.None; // "none" + ``` + + **After (v6):** + + ```ts + 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):** + + ```ts + // 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):** + + ```ts + // 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):** + + ```ts + // 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 + }, + }); + ``` diff --git a/v6_MIGRATION_GUIDE.md b/v6_MIGRATION_GUIDE.md new file mode 100644 index 0000000000..d1eb6bd699 --- /dev/null +++ b/v6_MIGRATION_GUIDE.md @@ -0,0 +1,158 @@ +# V6 Migration Guide + +A guide to migrating the Auth0 Node.js SDK from `5.x` to `6.x`. + +- [Overall changes](#overall-changes) +- [Breaking changes](#breaking-changes) + - [ConnectionAttributeIdentifier replaced with identifier-specific types](#connectionattributeidentifier-replaced-with-identifier-specific-types) + - [PhoneProviderProtectionBackoffStrategyEnum value change](#phoneproviderprotectionbackoffstrategyenum-value-change) + - [users.federatedConnectionsTokensets removed](#usersfederatedconnectionstokensets-removed) + - [federated_connections_access_tokens removed from connection options](#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: + +| Attribute | Old type | New type | `default_method` values | +| -------------- | ------------------------------- | ----------------------------- | ----------------------------- | +| `email` | `ConnectionAttributeIdentifier` | `EmailAttributeIdentifier` | `"password"` \| `"email_otp"` | +| `phone_number` | `ConnectionAttributeIdentifier` | `PhoneAttributeIdentifier` | `"password"` \| `"phone_otp"` | +| `username` | `ConnectionAttributeIdentifier` | `UsernameAttributeIdentifier` | _(no `default_method`)_ | + +**Before (v5):** + +```ts +import { Management } from "auth0"; + +const identifier: Management.ConnectionAttributeIdentifier = { + active: true, + default_method: "email_otp", +}; +``` + +**After (v6):** + +```ts +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):** + +```ts +import { Management } from "auth0"; + +const strategy = Management.PhoneProviderProtectionBackoffStrategyEnum.None; // "none" +``` + +**After (v6):** + +```ts +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):** + +```ts +// 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):** + +```ts +// 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):** + +```ts +// 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 + }, +}); +```