auth0 5.10.0 → 5.11.0

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

@@ -56,7 +56,7 @@ class RulesClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * Retrieve a filtered list of <a href="https://auth0.com/docs/rules">rules</a>. Accepts a list of fields to include or exclude.
+     * Retrieve a filtered list of [rules](https://auth0.com/docs/rules). Accepts a list of fields to include or exclude.
      *
      * @param {Management.ListRulesRequestParameters} request
      * @param {RulesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -150,9 +150,9 @@ class RulesClient {
         });
     }
     /**
-     * Create a <a href="https://auth0.com/docs/rules#create-a-new-rule-using-the-management-api">new rule</a>.
+     * Create a [new rule](https://auth0.com/docs/rules#create-a-new-rule-using-the-management-api).
      *
-     * Note: Changing a rule's stage of execution from the default <code>login_success</code> can change the rule's function signature to have user omitted.
+     * Note: Changing a rule's stage of execution from the default `login_success` can change the rule's function signature to have user omitted.
      *
      * @param {Management.CreateRuleRequestContent} request
      * @param {RulesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -218,7 +218,7 @@ class RulesClient {
         });
     }
     /**
-     * Retrieve <a href="https://auth0.com/docs/rules">rule</a> details. Accepts a list of fields to include or exclude in the result.
+     * Retrieve [rule](https://auth0.com/docs/rules) details. Accepts a list of fields to include or exclude in the result.
      *
      * @param {string} id - ID of the rule to retrieve.
      * @param {Management.GetRuleRequestParameters} request

package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts

@@ -29,7 +29,7 @@ export declare class UserAttributeProfilesClient {
      */
     list(request?: Management.ListUserAttributeProfileRequestParameters, requestOptions?: UserAttributeProfilesClient.RequestOptions): Promise<core.Page<Management.UserAttributeProfile, Management.ListUserAttributeProfilesPaginatedResponseContent>>;
     /**
-     * Create a User Attribute Profile
+     * Create a User Attribute Profile.
      *
      * @param {Management.CreateUserAttributeProfileRequestContent} request
      * @param {UserAttributeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -137,7 +137,7 @@ class UserAttributeProfilesClient {
         });
     }
     /**
-     * Create a User Attribute Profile
+     * Create a User Attribute Profile.
      *
      * @param {Management.CreateUserAttributeProfileRequestContent} request
      * @param {UserAttributeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/management/api/resources/userBlocks/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare class UserBlocksClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<UserBlocksClient.Options>;
     constructor(options: UserBlocksClient.Options);
     /**
-     * Retrieve details of all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for a user with the given identifier (username, phone number, or email).
+     * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
      *
      * @param {Management.ListUserBlocksByIdentifierRequestParameters} request
      * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -30,9 +30,9 @@ export declare class UserBlocksClient {
     listByIdentifier(request: Management.ListUserBlocksByIdentifierRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<Management.ListUserBlocksByIdentifierResponseContent>;
     private __listByIdentifier;
     /**
-     * Remove all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given identifier (username, phone number, or email).
+     * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email).
      *
-     * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by a tenant administrator</a>.
+     * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
      *
      * @param {Management.DeleteUserBlocksByIdentifierRequestParameters} request
      * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,7 +50,7 @@ export declare class UserBlocksClient {
     deleteByIdentifier(request: Management.DeleteUserBlocksByIdentifierRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteByIdentifier;
     /**
-     * Retrieve details of all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given ID.
+     * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
      *
      * @param {string} id - user_id of the user blocks to retrieve.
      * @param {Management.ListUserBlocksRequestParameters} request
@@ -70,9 +70,9 @@ export declare class UserBlocksClient {
     list(id: string, request?: Management.ListUserBlocksRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<Management.ListUserBlocksResponseContent>;
     private __list;
     /**
-     * Remove all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given ID.
+     * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
      *
-     * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by a tenant administrator</a>.
+     * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
      *
      * @param {string} id - The user_id of the user to update.
      * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -56,7 +56,7 @@ class UserBlocksClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * Retrieve details of all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for a user with the given identifier (username, phone number, or email).
+     * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
      *
      * @param {Management.ListUserBlocksByIdentifierRequestParameters} request
      * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -128,9 +128,9 @@ class UserBlocksClient {
         });
     }
     /**
-     * Remove all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given identifier (username, phone number, or email).
+     * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email).
      *
-     * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by a tenant administrator</a>.
+     * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
      *
      * @param {Management.DeleteUserBlocksByIdentifierRequestParameters} request
      * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -197,7 +197,7 @@ class UserBlocksClient {
         });
     }
     /**
-     * Retrieve details of all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given ID.
+     * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
      *
      * @param {string} id - user_id of the user blocks to retrieve.
      * @param {Management.ListUserBlocksRequestParameters} request
@@ -271,9 +271,9 @@ class UserBlocksClient {
         });
     }
     /**
-     * Remove all <a href="https://auth0.com/docs/secure/attack-protection/brute-force-protection">Brute-force Protection</a> blocks for the user with the given ID.
+     * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
      *
-     * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by a tenant administrator</a>.
+     * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
      *
      * @param {string} id - The user_id of the user to update.
      * @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/management/api/resources/users/client/Client.d.ts

@@ -5,6 +5,8 @@ import * as Management from "../../../index.js";
 import { AuthenticationMethodsClient } from "../resources/authenticationMethods/client/Client.js";
 import { AuthenticatorsClient } from "../resources/authenticators/client/Client.js";
 import { ConnectedAccountsClient } from "../resources/connectedAccounts/client/Client.js";
+import { EffectivePermissionsClient } from "../resources/effectivePermissions/client/Client.js";
+import { EffectiveRolesClient } from "../resources/effectiveRoles/client/Client.js";
 import { EnrollmentsClient } from "../resources/enrollments/client/Client.js";
 import { FederatedConnectionsTokensetsClient } from "../resources/federatedConnectionsTokensets/client/Client.js";
 import { GroupsClient } from "../resources/groups/client/Client.js";
@@ -27,6 +29,8 @@ export declare class UsersClient {
     protected _authenticationMethods: AuthenticationMethodsClient | undefined;
     protected _authenticators: AuthenticatorsClient | undefined;
     protected _connectedAccounts: ConnectedAccountsClient | undefined;
+    protected _effectivePermissions: EffectivePermissionsClient | undefined;
+    protected _effectiveRoles: EffectiveRolesClient | undefined;
     protected _enrollments: EnrollmentsClient | undefined;
     protected _federatedConnectionsTokensets: FederatedConnectionsTokensetsClient | undefined;
     protected _groups: GroupsClient | undefined;
@@ -43,6 +47,8 @@ export declare class UsersClient {
     get authenticationMethods(): AuthenticationMethodsClient;
     get authenticators(): AuthenticatorsClient;
     get connectedAccounts(): ConnectedAccountsClient;
+    get effectivePermissions(): EffectivePermissionsClient;
+    get effectiveRoles(): EffectiveRolesClient;
     get enrollments(): EnrollmentsClient;
     get federatedConnectionsTokensets(): FederatedConnectionsTokensetsClient;
     get groups(): GroupsClient;
@@ -62,14 +68,18 @@ export declare class UsersClient {
      * - 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
-     *  <!-- only v3 is available -->
-     * The <code>q</code> query parameter can be used to get users that match the specified criteria <a href="https://auth0.com/docs/users/search/v3/query-syntax">using query string syntax.</a>
      *
-     * <a href="https://auth0.com/docs/users/search/v3">Learn more about searching for users.</a>
      *
-     * Read about <a href="https://auth0.com/docs/users/search/best-practices">best practices</a> 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 <a href="https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports">export job</a>, or the <a href="https://auth0.com/docs/extensions/user-import-export">User Import / Export</a> extension.
+     * 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)
+     *
+     * [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.
      *
      * @param {Management.ListUsersRequestParameters} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -96,9 +106,9 @@ export declare class UsersClient {
      */
     list(request?: Management.ListUsersRequestParameters, requestOptions?: UsersClient.RequestOptions): Promise<core.Page<Management.UserResponseSchema, Management.ListUsersOffsetPaginatedResponseContent>>;
     /**
-     * Create a new user for a given <a href="https://auth0.com/docs/connections/database">database</a> or <a href="https://auth0.com/docs/connections/passwordless">passwordless</a> connection.
+     * Create a new user for a given [database](https://auth0.com/docs/connections/database) or [passwordless](https://auth0.com/docs/connections/passwordless) connection.
      *
-     * Note: <code>connection</code> is required but other parameters such as <code>email</code> and <code>password</code> are dependent upon the type of connection.
+     * Note: `connection` is required but other parameters such as `email` and `password` are dependent upon the type of connection.
      *
      * @param {Management.CreateUserRequestContent} request
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -141,7 +151,7 @@ export declare class UsersClient {
     listUsersByEmail(request: Management.ListUsersByEmailRequestParameters, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.UserResponseSchema[]>;
     private __listUsersByEmail;
     /**
-     * Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see <a href="https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint">Retrieve Users with the Get Users Endpoint</a>.
+     * Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see [Retrieve Users with the Get Users Endpoint](https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint).
      *
      * @param {string} id - ID of the user to retrieve.
      * @param {Management.GetUserRequestParameters} request
@@ -162,7 +172,7 @@ export declare class UsersClient {
     get(id: string, request?: Management.GetUserRequestParameters, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.GetUserResponseContent>;
     private __get;
     /**
-     * Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see <a href="https://auth0.com/docs/manage-users/user-accounts/delete-users">Delete Users</a>.
+     * Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see [Delete Users](https://auth0.com/docs/manage-users/user-accounts/delete-users).
      *
      * @param {string} id - ID of the user to delete.
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -182,64 +192,84 @@ export declare class UsersClient {
      *
      * These are the attributes that can be updated at the root level:
      *
-     * <ul>
-     *     <li>app_metadata</li>
-     *     <li>blocked</li>
-     *     <li>email</li>
-     *     <li>email_verified</li>
-     *     <li>family_name</li>
-     *     <li>given_name</li>
-     *     <li>name</li>
-     *     <li>nickname</li>
-     *     <li>password</li>
-     *     <li>phone_number</li>
-     *     <li>phone_verified</li>
-     *     <li>picture</li>
-     *     <li>username</li>
-     *     <li>user_metadata</li>
-     *     <li>verify_email</li>
-     * </ul>
+     * - app_metadata
+     * - blocked
+     * - email
+     * - email_verified
+     * - family_name
+     * - given_name
+     * - name
+     * - nickname
+     * - password
+     * - phone_number
+     * - phone_verified
+     * - picture
+     * - username
+     * - user_metadata
+     * - verify_email
      *
      * Some considerations:
-     * <ul>
-     *     <li>The properties of the new object will replace the old ones.</li>
-     *     <li>The metadata fields are an exception to this rule (<code>user_metadata</code> and <code>app_metadata</code>). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.</li>
-     *     <li>If you are updating <code>email</code>, <code>email_verified</code>, <code>phone_number</code>, <code>phone_verified</code>, <code>username</code> or <code>password</code> of a secondary identity, you need to specify the <code>connection</code> property too.</li>
-     *     <li>If you are updating <code>email</code> or <code>phone_number</code> you can specify, optionally, the <code>client_id</code> property.</li>
-     *     <li>Updating <code>email_verified</code> is not supported for enterprise and passwordless sms connections.</li>
-     *     <li>Updating the <code>blocked</code> to <code>false</code> does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.</li>
-     *     <li>Supported attributes can be unset by supplying <code>null</code> as the value.</li>
-     * </ul>
-     *
-     * <h5>Updating a field (non-metadata property)</h5>
+     *
+     * - The properties of the new object will replace the old ones.
+     * - The metadata fields are an exception to this rule (`user_metadata` and `app_metadata`). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
+     * - If you are updating `email`, `email_verified`, `phone_number`, `phone_verified`, `username` or `password` of a secondary identity, you need to specify the `connection` property too.
+     * - If you are updating `email` or `phone_number` you can specify, optionally, the `client_id` property.
+     * - Updating `email_verified` is not supported for enterprise and passwordless sms connections.
+     * - Updating the `blocked` to `false` does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.
+     * - Supported attributes can be unset by supplying `null` as the value.
+     *
+     * **Updating a field (non-metadata property)**
+     *
      * To mark the email address of a user as verified, the body to send should be:
-     * <pre><code>{ "email_verified": true }</code></pre>
      *
-     * <h5>Updating a user metadata root property</h5>Let's assume that our test user has the following <code>user_metadata</code>:
-     * <pre><code>{ "user_metadata" : { "profileCode": 1479 } }</code></pre>
+     * ```json
+     * { "email_verified": true }
+     * ```
      *
-     * To add the field <code>addresses</code> the body to send should be:
-     * <pre><code>{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}</code></pre>
+     * **Updating a user metadata root property**
      *
-     * The modified object ends up with the following <code>user_metadata</code> property:<pre><code>{
+     * Let's assume that our test user has the following `user_metadata`:
+     *
+     * ```json
+     * { "user_metadata" : { "profileCode": 1479 } }
+     * ```
+     *
+     * To add the field `addresses` the body to send should be:
+     *
+     * ```json
+     * { "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
+     * ```
+     *
+     * The modified object ends up with the following `user_metadata` property:
+     *
+     * ```json
+     * {
      *   "user_metadata": {
      *     "profileCode": 1479,
      *     "addresses": { "work_address": "100 Industrial Way" }
      *   }
-     * }</code></pre>
+     * }
+     * ```
+     *
+     * **Updating an inner user metadata property**
      *
-     * <h5>Updating an inner user metadata property</h5>If there's existing user metadata to which we want to add  <code>"home_address": "742 Evergreen Terrace"</code> (using the <code>addresses</code> property) we should send the whole <code>addresses</code> object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
-     * <pre><code>{
+     * If there's existing user metadata to which we want to add  `"home_address": "742 Evergreen Terrace"` (using the `addresses` property) we should send the whole `addresses` object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
+     *
+     * ```json
+     * {
      *   "user_metadata": {
      *     "addresses": {
      *       "work_address": "100 Industrial Way",
      *       "home_address": "742 Evergreen Terrace"
      *     }
      *   }
-     * }</code></pre>
+     * }
+     * ```
+     *
+     * The modified object ends up with the following `user_metadata` property:
      *
-     * The modified object ends up with the following <code>user_metadata</code> property:
-     * <pre><code>{
+     * ```json
+     * {
      *   "user_metadata": {
      *     "profileCode": 1479,
      *     "addresses": {
@@ -247,7 +277,8 @@ export declare class UsersClient {
      *       "home_address": "742 Evergreen Terrace"
      *     }
      *   }
-     * }</code></pre>
+     * }
+     * ```
      *
      * @param {string} id - ID of the user to update.
      * @param {Management.UpdateUserRequestContent} request
@@ -265,7 +296,7 @@ export declare class UsersClient {
     update(id: string, request?: Management.UpdateUserRequestContent, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.UpdateUserResponseContent>;
     private __update;
     /**
-     * Remove an existing multi-factor authentication (MFA) <a href="https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa">recovery code</a> and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
+     * Remove an existing multi-factor authentication (MFA) [recovery code](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa) and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
      *
      * @param {string} id - ID of the user to regenerate a multi-factor authentication recovery code for.
      * @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.