auth0-deploy-cli 8.42.0 → 8.44.0

package/lib/context/yaml/index.js

@@ -43,15 +43,14 @@ class YAMLContext {
         })();
     }
     loadFile(f) {
-        let toLoad = path_1.default.join(this.basePath, f);
-        if (!(0, utils_1.isFile)(toLoad)) {
-            // try load not relative to yaml file
-            toLoad = f;
-            logger_1.default.warn(`Support for absolute paths and paths outside the config root will be deprecated in a future version to improve the security of the tool. ` +
-                `Please update your configuration to use paths relative to the config directory. ` +
-                `Current absolute path used: ["${f}"]`);
+        const configRoot = path_1.default.resolve(this.basePath);
+        const toLoad = path_1.default.resolve(this.basePath, f.replace(/\\/g, '/'));
+        if (!toLoad.startsWith(configRoot + path_1.default.sep)) {
+            logger_1.default.warn(`Path "${f}" resolves to "${toLoad}" which is outside the config directory "${configRoot}". ` +
+                `This will be blocked as an error in the next major release. ` +
+                `Move the file inside your config directory.`);
         }
-        return (0, tools_1.loadFileAndReplaceKeywords)(path_1.default.resolve(toLoad), {
+        return (0, tools_1.loadFileAndReplaceKeywords)(toLoad, {
             mappings: this.mappings,
             disableKeywordReplacement: this.disableKeywordReplacement,
         });

package/lib/readonly.js

@@ -28,6 +28,11 @@ const readOnlyFields = {
         'config_route',
         'owners',
     ],
+    attackProtection: [
+        // Returned by GET but rejected by PATCH with "Additional properties not allowed"
+        'bruteForceProtection.form_submission_mode',
+        'bruteForceProtection.form_submission_behavior',
+    ],
 };
 function getExcludedFields(config) {
     const strippedFields = { ...readOnlyFields };

package/lib/tools/auth0/handlers/attackProtection.js

@@ -314,7 +314,9 @@ class AttackProtectionHandler extends default_1.default {
             updates.push(this.client.attackProtection.captcha.update(attackProtection.captcha));
         }
         if (attackProtection.bruteForceProtection) {
-            updates.push(this.client.attackProtection.bruteForceProtection.update(attackProtection.bruteForceProtection));
+            // Strip fields returned by GET but rejected by PATCH
+            const { form_submission_mode, form_submission_behavior, ...bruteForcePayload } = attackProtection.bruteForceProtection;
+            updates.push(this.client.attackProtection.bruteForceProtection.update(bruteForcePayload));
         }
         if (attackProtection.suspiciousIpThrottling) {
             updates.push(this.client.attackProtection.suspiciousIpThrottling.update(attackProtection.suspiciousIpThrottling));

package/lib/tools/auth0/handlers/clients.d.ts

@@ -254,6 +254,27 @@ export declare const schema: {
                         enum: ("allow" | "allow_if_empty")[];
                         description: string;
                     };
+                    third_party_client_access: {
+                        type: string;
+                        description: string;
+                        properties: {
+                            default_value: {
+                                type: string;
+                                enum: "block"[];
+                                description: string;
+                            };
+                            allowed_values: {
+                                type: string;
+                                items: {
+                                    type: string;
+                                    enum: ("allow" | "block")[];
+                                };
+                                uniqueItems: boolean;
+                                description: string;
+                            };
+                        };
+                        required: string[];
+                    };
                     invitation_landing_client_id: {
                         type: string;
                         description: string;

package/lib/tools/auth0/handlers/clients.js

@@ -59,6 +59,27 @@ const myOrganizationConfigurationSchema = {
             enum: Object.values(auth0_1.Management.ClientMyOrganizationDeletionBehaviorEnum),
             description: 'The deletion behavior for My Organization connections created by this client',
         },
+        third_party_client_access: {
+            type: 'object',
+            description: 'Controls whether third-party clients can access the organization via the My Organization API.',
+            properties: {
+                default_value: {
+                    type: 'string',
+                    enum: Object.values(auth0_1.Management.ClientMyOrganizationConfigurationThirdPartyClientAccessDefaultValueEnum),
+                    description: 'The default third-party client access value.',
+                },
+                allowed_values: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                        enum: Object.values(auth0_1.Management.ClientMyOrganizationConfigurationThirdPartyClientAccessAllowedValuesEnum),
+                    },
+                    uniqueItems: true,
+                    description: 'The allowed third-party client access values.',
+                },
+            },
+            required: ['default_value', 'allowed_values'],
+        },
         invitation_landing_client_id: {
             type: 'string',
             description: 'The client ID of the invitation landing client for the My Organization configuration',

package/lib/tools/auth0/handlers/connectionProfiles.d.ts

@@ -36,6 +36,33 @@ export declare const schema: {
             connection_config: {
                 type: string[];
             };
+            cross_app_access_resource_app: {
+                type: string;
+                description: string;
+                properties: {
+                    status: {
+                        type: string;
+                        properties: {
+                            default_value: {
+                                type: string;
+                                enum: ("enabled" | "disabled")[];
+                                description: string;
+                            };
+                            allowed_values: {
+                                type: string;
+                                items: {
+                                    type: string;
+                                    enum: ("enabled" | "disabled")[];
+                                };
+                                uniqueItems: boolean;
+                                description: string;
+                            };
+                        };
+                        required: string[];
+                    };
+                };
+                required: string[];
+            };
             strategy_overrides: {
                 type: string[];
                 properties: {

package/lib/tools/auth0/handlers/connectionProfiles.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConnectionProfile = exports.schema = void 0;
+const auth0_1 = require("auth0");
 const default_1 = __importDefault(require("./default"));
 const client_1 = require("../client");
 const logger_1 = __importDefault(require("../../../logger"));
@@ -42,6 +43,35 @@ exports.schema = {
             connection_config: {
                 type: ['object', 'null'],
             },
+            cross_app_access_resource_app: {
+                type: 'object',
+                description: 'Controls whether organization admins may enable Cross App Access (XAA) on their Identity Providers.',
+                properties: {
+                    status: {
+                        type: 'object',
+                        properties: {
+                            default_value: {
+                                type: 'string',
+                                enum: Object.values(auth0_1.Management.ConnectionProfileCrossAppAccessResourceAppStatusDefaultValueEnum),
+                                description: 'The default Cross App Access resource app status.',
+                            },
+                            allowed_values: {
+                                type: 'array',
+                                items: {
+                                    type: 'string',
+                                    enum: Object.values(auth0_1.Management.ConnectionProfileCrossAppAccessResourceAppStatusValueEnum),
+                                },
+                                uniqueItems: true,
+                                description: 'The allowed Cross App Access resource app status values.',
+                            },
+                        },
+                        // allowed_values is optional per the SDK type (unlike the client's
+                        // third_party_client_access, which requires both fields).
+                        required: ['default_value'],
+                    },
+                },
+                required: ['status'],
+            },
             strategy_overrides: {
                 type: ['object', 'null'],
                 properties: {

package/lib/tools/auth0/handlers/connections.d.ts

@@ -159,6 +159,15 @@ export declare const schema: {
                                 id: {
                                     type: string;
                                 };
+                                name: {
+                                    type: string;
+                                };
+                                email: {
+                                    type: string;
+                                };
+                                direct_members_count: {
+                                    type: string;
+                                };
                             };
                             required: string[];
                         };
@@ -173,9 +182,7 @@ type DirectoryProvisioningConfig = Management.DirectoryProvisioning;
 export type Connection = Management.ConnectionForList & {
     enabled_clients?: string[];
     directory_provisioning_configuration?: Pick<DirectoryProvisioningConfig, 'mapping' | 'synchronize_automatically' | 'synchronize_groups'> & {
-        synchronized_groups?: Array<{
-            id: string;
-        }>;
+        synchronized_groups?: Management.SynchronizedGroupPayload[];
     };
 };
 export declare const addExcludedConnectionPropertiesToChanges: ({ proposedChanges, existingConnections, config, }: {
@@ -251,9 +258,7 @@ export default class ConnectionsHandler extends DefaultAPIHandler {
     /**
      * Retrieves all synchronized groups for a connection using checkpoint pagination.
      */
-    getConnectionSynchronizedGroups(connectionId: string): Promise<Array<{
-        id: string;
-    }> | null>;
+    getConnectionSynchronizedGroups(connectionId: string): Promise<Management.SynchronizedGroupPayload[] | null>;
     /**
      * Replaces the synchronized groups for a connection (PUT replace-all semantics).
      */

package/lib/tools/auth0/handlers/connections.js

@@ -172,6 +172,9 @@ exports.schema = {
                             type: 'object',
                             properties: {
                                 id: { type: 'string' },
+                                name: { type: 'string' },
+                                email: { type: 'string' },
+                                direct_members_count: { type: 'number' },
                             },
                             required: ['id'],
                         },
@@ -377,12 +380,15 @@ class ConnectionsHandler extends default_1.default {
     }
     getFormattedOptions(connection, clients) {
         try {
+            const { idpinitiated } = connection.options;
             return {
                 options: {
                     ...connection.options,
                     idpinitiated: {
-                        ...connection.options.idpinitiated,
-                        client_id: (0, utils_1.convertClientNameToId)(connection.options.idpinitiated.client_id, clients),
+                        ...idpinitiated,
+                        ...(idpinitiated.client_id && {
+                            client_id: (0, utils_1.convertClientNameToId)(idpinitiated.client_id, clients),
+                        }),
                     },
                 },
             };
@@ -483,12 +489,28 @@ class ConnectionsHandler extends default_1.default {
         try {
             const groups = [];
             let page = await this.client.connections.directoryProvisioning.listSynchronizedGroups(connectionId, {});
-            for (const g of page.data ?? [])
-                groups.push({ id: g.id });
+            for (const g of page.data ?? []) {
+                groups.push({
+                    id: g.id,
+                    ...(g.name !== undefined && { name: g.name }),
+                    ...(g.email !== undefined && { email: g.email }),
+                    ...(g.direct_members_count !== undefined && {
+                        direct_members_count: g.direct_members_count,
+                    }),
+                });
+            }
             while (page.hasNextPage?.()) {
                 page = await page.getNextPage();
-                for (const g of page.data ?? [])
-                    groups.push({ id: g.id });
+                for (const g of page.data ?? []) {
+                    groups.push({
+                        id: g.id,
+                        ...(g.name !== undefined && { name: g.name }),
+                        ...(g.email !== undefined && { email: g.email }),
+                        ...(g.direct_members_count !== undefined && {
+                            direct_members_count: g.direct_members_count,
+                        }),
+                    });
+                }
             }
             return groups;
         }
@@ -725,7 +747,11 @@ class ConnectionsHandler extends default_1.default {
                 ...(enabledClients !== undefined && { enabled_clients: enabledClients }),
             };
         });
-        const proposedChanges = await super.dryRunChanges({ ...assets, connections: formatted });
+        let proposedChanges = await super.dryRunChanges({ ...assets, connections: formatted });
+        const includedConnections = (assets.include && assets.include.connections) || [];
+        const excludedConnections = (assets.exclude && assets.exclude.connections) || [];
+        proposedChanges = (0, utils_1.filterExcluded)(proposedChanges, excludedConnections);
+        proposedChanges = (0, utils_1.filterIncluded)(proposedChanges, includedConnections);
         return (0, exports.addExcludedConnectionPropertiesToChanges)({
             proposedChanges,
             existingConnections,

package/lib/tools/auth0/handlers/databases.js

@@ -462,12 +462,21 @@ class DatabaseHandler extends default_1.default {
             }
             return connection;
         });
+        // A connection can return both legacy password fields and `password_options` on read, but
+        // they're mutually exclusive on write. Strip the legacy fields to keep the export deployable.
+        const dbConnectionsNormalized = dbConnectionsWithActionNames.map((connection) => {
+            if (connection.options && 'password_options' in connection.options) {
+                const { passwordPolicy, password_complexity_options, password_history, password_no_personal_info, password_dictionary, ...options } = connection.options;
+                return { ...connection, options };
+            }
+            return connection;
+        });
         // If options option is empty for all connection, log the missing options scope.
-        const isOptionExists = dbConnectionsWithActionNames.every((c) => c.options && Object.keys(c.options).length > 0);
+        const isOptionExists = dbConnectionsNormalized.every((c) => c.options && Object.keys(c.options).length > 0);
         if (!isOptionExists) {
             logger_1.default.warn(`Insufficient scope the read:connections_options scope is required to get ${this.type} options.`);
         }
-        this.existing = dbConnectionsWithActionNames;
+        this.existing = dbConnectionsNormalized;
         return this.existing;
     }
     async calcChanges(assets) {
@@ -545,7 +554,7 @@ class DatabaseHandler extends default_1.default {
             assets: formatted,
             existing: existingDatabasesConnections,
             identifiers: this.identifiers,
-            ignoreDryRunFields: this.ignoreDryRunFields,
+            ignoreDryRunFields: this.getEffectiveIgnoreDryRunFields(),
         });
     }
     // Run after clients are updated so we can convert all the enabled_clients names to id's

package/lib/tools/auth0/handlers/default.d.ts

@@ -1,6 +1,20 @@
 import { Asset, Assets, Auth0APIClient, CalculatedChanges } from '../../../types';
 import { ConfigFunction } from '../../../configFactory';
 export declare function order(value: any): (t: any, n: any, descriptor: any) => any;
+export interface RetryOptions {
+    maxRetries?: number;
+    initialDelay?: number;
+    maxDelay?: number;
+    onRetry?: (error: any, attempt: number, delay: number) => void;
+}
+/**
+ * Executes a function with exponential backoff retry logic for rate limit errors (429).
+ *
+ * @param fn - The function to execute with retry logic
+ * @param options - Configuration options for retry behavior
+ * @returns Promise that resolves with the function result or rejects after max retries
+ */
+export declare function retryWithExponentialBackoff<T>(fn: () => Promise<T>, options?: RetryOptions): Promise<T>;
 type ApiMethodOverride = string | Function;
 export default class APIHandler {
     config: ConfigFunction;
@@ -50,6 +64,15 @@ export default class APIHandler {
      */
     getEffectiveIgnoreDryRunFields(): string[];
     getClientFN(fn: ApiMethodOverride): Function;
+    /**
+     * Builds the exponential-backoff retry configuration for this handler from the
+     * shared `AUTH0_MAX_RETRIES` / `AUTH0_RETRY_INITIAL_DELAY_MS` /
+     * `AUTH0_RETRY_MAX_DELAY_MS` config keys. Exposed so that handlers which issue
+     * writes outside the default `processChanges` flow (e.g. organizations, which
+     * writes nested connections/grants directly) can wrap those calls in the same
+     * 429 backoff behaviour as the base handler.
+     */
+    getRetryConfig(): RetryOptions;
     didDelete(item: Asset): void;
     didCreate(item: Asset): void;
     didUpdate(item: Asset): void;

package/lib/tools/auth0/handlers/default.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.order = order;
+exports.retryWithExponentialBackoff = retryWithExponentialBackoff;
 const auth0_1 = require("auth0");
 const validationError_1 = __importDefault(require("../../validationError"));
 const utils_1 = require("../../utils");
@@ -114,6 +115,25 @@ class APIHandler {
         }
         return fn;
     }
+    /**
+     * Builds the exponential-backoff retry configuration for this handler from the
+     * shared `AUTH0_MAX_RETRIES` / `AUTH0_RETRY_INITIAL_DELAY_MS` /
+     * `AUTH0_RETRY_MAX_DELAY_MS` config keys. Exposed so that handlers which issue
+     * writes outside the default `processChanges` flow (e.g. organizations, which
+     * writes nested connections/grants directly) can wrap those calls in the same
+     * 429 backoff behaviour as the base handler.
+     */
+    getRetryConfig() {
+        const retryConfig = {
+            maxRetries: this.config('AUTH0_MAX_RETRIES') || DEFAULT_MAX_RETRIES,
+            initialDelay: this.config('AUTH0_RETRY_INITIAL_DELAY_MS') || DEFAULT_INITIAL_DELAY_MS,
+            maxDelay: this.config('AUTH0_RETRY_MAX_DELAY_MS') || DEFAULT_MAX_DELAY_MS,
+            onRetry: (error, attempt, delay) => {
+                logger_1.default.warn(`Rate limit hit for [${this.type}]. Retrying attempt ${attempt}/${retryConfig.maxRetries} after ${Math.round(delay / 1000)}s...`);
+            },
+        };
+        return retryConfig;
+    }
     didDelete(item) {
         logger_1.default.info(`Deleted [${this.type}]: ${this.objString(item)}`);
     }
@@ -210,7 +230,6 @@ class APIHandler {
             return (0, calculateDryRunChanges_1.calculateDryRunChanges)({
                 type: this.type,
                 assets: typeAssets,
-                // @ts-ignore TODO: investigate what happens when `existing` is null
                 existing,
                 identifiers: this.identifiers,
                 ignoreDryRunFields: this.getEffectiveIgnoreDryRunFields(),
@@ -243,7 +262,6 @@ class APIHandler {
         return (0, calculateDryRunChanges_1.calculateDryRunChanges)({
             type: this.type,
             assets: typeAssets,
-            // @ts-ignore TODO: investigate what happens when `existing` is null
             existing,
             identifiers: this.identifiers,
             ignoreDryRunFields: this.getEffectiveIgnoreDryRunFields(),
@@ -282,14 +300,7 @@ class APIHandler {
         const conflicts = changes.conflicts || [];
         logger_1.default.debug(`Start processChanges for ${this.type} [delete:${del.length}] [update:${update.length}], [create:${create.length}], [conflicts:${conflicts.length}]`);
         // Set retry configuration from config
-        const retryConfig = {
-            maxRetries: this.config('AUTH0_MAX_RETRIES') || DEFAULT_MAX_RETRIES,
-            initialDelay: this.config('AUTH0_RETRY_INITIAL_DELAY_MS') || DEFAULT_INITIAL_DELAY_MS,
-            maxDelay: this.config('AUTH0_RETRY_MAX_DELAY_MS') || DEFAULT_MAX_DELAY_MS,
-            onRetry: (error, attempt, delay) => {
-                logger_1.default.warn(`Rate limit hit for [${this.type}]. Retrying attempt ${attempt}/${retryConfig.maxRetries} after ${Math.round(delay / 1000)}s...`);
-            },
-        };
+        const retryConfig = this.getRetryConfig();
         // Process Deleted
         if (del.length > 0) {
             const allowDelete = this.config('AUTH0_ALLOW_DELETE') === 'true' || this.config('AUTH0_ALLOW_DELETE') === true;

package/lib/tools/auth0/handlers/organizations.d.ts

@@ -1,6 +1,7 @@
 import { Management } from 'auth0';
 import DefaultHandler from './default';
 import { Asset, Assets, CalculatedChanges } from '../../../types';
+import { Client } from './clients';
 export declare const schema: {
     type: string;
     items: {
@@ -108,6 +109,25 @@ export declare const schema: {
                 type: string;
                 enum: ("allow" | "block")[];
             };
+            is_app_entitlement_active: {
+                type: string;
+            };
+            clients: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        client_id: {
+                            type: string;
+                        };
+                        use_for_member_access: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                };
+                default: never[];
+            };
         };
         required: string[];
     };
@@ -119,6 +139,7 @@ type FormattedClientGrants = {
 export default class OrganizationsHandler extends DefaultHandler {
     existing: Asset[];
     formattedClientGrants: FormattedClientGrants[];
+    allClients: Client[];
     constructor(config: DefaultHandler);
     deleteOrganization(org: any): Promise<void>;
     deleteOrganizations(data: Asset[]): Promise<void>;
@@ -126,8 +147,9 @@ export default class OrganizationsHandler extends DefaultHandler {
     createOrganizations(creates: CalculatedChanges['create']): Promise<void>;
     updateOrganization(org: any, organizations: any): Promise<{
         id: any;
-    }>;
+    } | null>;
     getClientGrantIDByClientName(clientsName: string): string;
+    getClientIdByClientName(clientName: string): string;
     getFormattedClientGrants(): Promise<FormattedClientGrants[]>;
     updateOrganizations(updates: CalculatedChanges['update'], orgs: Asset[]): Promise<void>;
     getType(): Promise<Asset[]>;
@@ -141,5 +163,11 @@ export default class OrganizationsHandler extends DefaultHandler {
     createOrganizationDiscoveryDomain(organizationId: string, discoveryDomain: Management.CreateOrganizationDiscoveryDomainRequestContent): Promise<Management.CreateOrganizationDiscoveryDomainResponseContent>;
     updateOrganizationDiscoveryDomain(organizationId: string, discoveryDomainId: string, discoveryDomain: string, discoveryDomainUpdate: Management.UpdateOrganizationDiscoveryDomainRequestContent): Promise<Management.UpdateOrganizationDiscoveryDomainResponseContent>;
     deleteOrganizationDiscoveryDomain(organizationId: string, discoveryDomain: string, discoveryDomainId: string): Promise<void>;
+    getAllOrganizationClients(organizationId: string): Promise<Management.OrganizationClient[] | null>;
+    createOrganizationClients(organizationId: string, clients: Array<{
+        client_id: string;
+        use_for_member_access: boolean;
+    }>): Promise<void>;
+    deleteOrganizationClients(organizationId: string, clientIds: string[]): Promise<void>;
 }
 export {};