auth0 7.2.0 → 7.4.0-beta.1

package/dist/cjs/management/api/resources/users/client/Client.js

@@ -136,24 +136,22 @@ class UsersClient {
         return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_js_16.SessionsClient(this._options)));
     }
     /**
-     * Retrieve details of users. It is possible to:
+     * This endpoint retrieves details of users. It's best suited to interactive, best-effort search and lookups where slightly stale results are acceptable. With it, you can:
      *
-     * - Specify a search criteria for users
+     * - Specify search criteria for users
      * - Sort the users to be returned
      * - Select the fields to be returned
      * - Specify the number of users to retrieve per page and the page index
      *
+     * This endpoint is **not suited for use in critical paths**. It is eventually consistent and runs under a short (~2 second) query time limit, so results can be stale and heavy queries can return a 503.
      *
+     * - Do not use this endpoint for authentication, account linking, or logic inside login-flow Actions. Instead, [look users up directly by ID or email](https://auth0.com/docs/manage-users/user-search/get-users-by-id-or-email#management-api) to get their current state.
+     * - Do not use this endpoint to keep an external system in sync with user data. Instead, subscribe to [Event Streams](https://auth0.com/docs/customize/events/sync-data-across-systems) to receive every change as it happens.
+     * - Do not use this endpoint to enumerate or export your entire user base. Instead, run a [bulk user export](https://auth0.com/docs/manage-users/user-migration/bulk-user-exports) to retrieve the full set.
      *
-     * The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax)
+     * Use the `q` query parameter to match users with [query string syntax](https://auth0.com/docs/manage-users/user-search/user-search-query-syntax). For full instructions and guidance, see [How to List and Search Users](https://auth0.com/docs/manage-users/user-search/list-and-search-users).
      *
-     * [Learn more about searching for users.](https://auth0.com/docs/users/search/v3)
-     *
-     * Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users.
-     *
-     *
-     *
-     * Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
+     * For efficient queries, prefer indexed top-level fields and exact matches. Certain kinds of queries can be slow and may time out, such as filtering on freeform or multi-value fields (like user-defined attributes in `app_metadata` or `user_metadata`) or using leading wildcards.
      *
      * @param {Management.ListUsersRequestParameters} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.