auth0 4.0.0-beta.6 → 4.0.0-beta.7

package/dist/esm/management/__generated/managers/roles-manager.d.ts

@@ -0,0 +1,110 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { GetOrganizationMemberRoles200ResponseOneOfInner, PostRolePermissionAssignmentRequest, PostRoleUsersRequest, RoleCreate, RoleUpdate, GetRolePermission200ResponseOneOf, Permission, GetRoleUser200ResponseOneOf, GetMembers200ResponseOneOfInner, GetOrganizationMemberRoles200ResponseOneOf, DeleteRolePermissionAssignmentRequest, DeleteRolesByIdRequest, GetRolePermissionRequest, GetRoleUserRequest, GetRolesRequest, GetRolesByIdRequest, PatchRolesByIdRequest, PostRolePermissionAssignmentOperationRequest, PostRoleUsersOperationRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class RolesManager extends BaseAPI {
+    /**
+     * Remove permissions associated with a role.
+     *
+     * Remove permissions from a role
+     *
+     * @throws {RequiredError}
+     */
+    deletePermissions(requestParameters: DeleteRolePermissionAssignmentRequest, bodyParameters: PostRolePermissionAssignmentRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Delete a role.
+     *
+     * Delete a role
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteRolesByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve list of permissions granted by a role.
+     *
+     * Get permissions granted by role
+     *
+     * @throws {RequiredError}
+     */
+    getPermissions(requestParameters: GetRolePermissionRequest & {
+        include_totals: true;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<GetRolePermission200ResponseOneOf>>;
+    getPermissions(requestParameters?: GetRolePermissionRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Permission>>>;
+    /**
+     * Retrieve users associated with a role. This endpoint supports two types of pagination:
+     * - Offset pagination
+     * - Checkpoint pagination
+     *
+     * Checkpoint pagination must be used if you need to retrieve more than 1000 users for a given role.
+     *
+     * <h2>Checkpoint Pagination</h2>
+     *
+     * To search by checkpoint, use the following parameters:
+     * - from: Optional id from which to start selection.
+     * - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
+     *
+     * Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the <code>from</code> parameter. If there are more results, a <code>next</code> value will be included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, this indicates there are no more pages remaining.
+     *
+     * Get a role's users
+     *
+     * @throws {RequiredError}
+     */
+    getUsers(requestParameters: GetRoleUserRequest & {
+        include_totals: true;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<GetRoleUser200ResponseOneOf>>;
+    getUsers(requestParameters?: GetRoleUserRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetMembers200ResponseOneOfInner>>>;
+    /**
+     * Retrieve filtered list of roles that can be assigned to users.
+     *
+     * Get roles
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters: GetRolesRequest & {
+        include_totals: true;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationMemberRoles200ResponseOneOf>>;
+    getAll(requestParameters?: GetRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetOrganizationMemberRoles200ResponseOneOfInner>>>;
+    /**
+     * Retrieve a role.
+     *
+     * Get a role
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetRolesByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationMemberRoles200ResponseOneOfInner>>;
+    /**
+     * Update a role.
+     *
+     * Update a role
+     *
+     * @throws {RequiredError}
+     */
+    update(requestParameters: PatchRolesByIdRequest, bodyParameters: RoleUpdate, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationMemberRoles200ResponseOneOfInner>>;
+    /**
+     * Associate permissions with a role.
+     *
+     * Associate permissions with a role
+     *
+     * @throws {RequiredError}
+     */
+    addPermissions(requestParameters: PostRolePermissionAssignmentOperationRequest, bodyParameters: PostRolePermissionAssignmentRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Assign users to a role.
+     * Assign users to a role
+     *
+     * @throws {RequiredError}
+     */
+    assignUsers(requestParameters: PostRoleUsersOperationRequest, bodyParameters: PostRoleUsersRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Create a new role.
+     *
+     * Create a role
+     *
+     * @throws {RequiredError}
+     */
+    create(bodyParameters: RoleCreate, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationMemberRoles200ResponseOneOfInner>>;
+}
+export {};

package/dist/esm/management/__generated/managers/rules-configs-manager.d.ts

@@ -0,0 +1,33 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { GetRulesConfigs200ResponseInner, PutRulesConfigsByKey200Response, PutRulesConfigsByKeyRequest, DeleteRulesConfigsByKeyRequest, PutRulesConfigsByKeyOperationRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class RulesConfigsManager extends BaseAPI {
+    /**
+     * Delete a rules config variable identified by its key.
+     * Delete rules config for a given key
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteRulesConfigsByKeyRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve rules config variable keys.
+     *
+     *     Note: For security, config variable values cannot be retrieved outside rule execution.
+     * Retrieve config variable keys for rules (get_rules-configs)
+     *
+     * @throws {RequiredError}
+     */
+    getAll(initOverrides?: InitOverride): Promise<ApiResponse<Array<GetRulesConfigs200ResponseInner>>>;
+    /**
+     * Sets a rules config variable.
+     * Set rules config for a given key
+     *
+     * @throws {RequiredError}
+     */
+    set(requestParameters: PutRulesConfigsByKeyOperationRequest, bodyParameters: PutRulesConfigsByKeyRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutRulesConfigsByKey200Response>>;
+}
+export {};

package/dist/esm/management/__generated/managers/rules-manager.d.ts

@@ -0,0 +1,55 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { Rule, RuleCreate, RuleUpdate, GetRules200ResponseOneOf, DeleteRulesByIdRequest, GetRulesRequest, GetRulesByIdRequest, PatchRulesByIdRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class RulesManager extends BaseAPI {
+    /**
+     * Delete a rule.
+     *
+     * Delete a rule
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteRulesByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve a filtered list of <a href="https://auth0.com/docs/rules">rules</a>. Accepts a list of fields to include or exclude.
+     *
+     * Get rules
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters: GetRulesRequest & {
+        include_totals: true;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<GetRules200ResponseOneOf>>;
+    getAll(requestParameters?: GetRulesRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Rule>>>;
+    /**
+     * Retrieve <a href="https://auth0.com/docs/rules">rule</a> details. Accepts a list of fields to include or exclude in the result.
+     *
+     * Get a rule
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetRulesByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Rule>>;
+    /**
+     * Update an existing rule.
+     *
+     * Update a rule
+     *
+     * @throws {RequiredError}
+     */
+    update(requestParameters: PatchRulesByIdRequest, bodyParameters: RuleUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Rule>>;
+    /**
+     * Create a <a href="https://auth0.com/docs/rules#create-a-new-rule-using-the-management-api">new rule</a>.
+     *
+     * 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.
+     *
+     * Create a rule
+     *
+     * @throws {RequiredError}
+     */
+    create(bodyParameters: RuleCreate, initOverrides?: InitOverride): Promise<ApiResponse<Rule>>;
+}
+export {};

package/dist/esm/management/__generated/managers/stats-manager.d.ts

@@ -0,0 +1,24 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { StatsEntry, GetDailyRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class StatsManager extends BaseAPI {
+    /**
+     * Retrieve the number of active users that logged in during the last 30 days.
+     * Get active users count
+     *
+     * @throws {RequiredError}
+     */
+    getActiveUsersCount(initOverrides?: InitOverride): Promise<ApiResponse<number>>;
+    /**
+     * Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range.
+     * Get daily stats
+     *
+     * @throws {RequiredError}
+     */
+    getDaily(requestParameters?: GetDailyRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<StatsEntry>>>;
+}
+export {};

package/dist/esm/management/__generated/managers/tenants-manager.d.ts

@@ -0,0 +1,24 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { TenantSettings, TenantSettingsUpdate, TenantSettingsRouteRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class TenantsManager extends BaseAPI {
+    /**
+     * Update settings for a tenant.
+     * Update tenant settings
+     *
+     * @throws {RequiredError}
+     */
+    updateSettings(bodyParameters: TenantSettingsUpdate, initOverrides?: InitOverride): Promise<ApiResponse<TenantSettings>>;
+    /**
+     * Retrieve tenant settings. A list of fields to include or exclude may also be specified.
+     * Get tenant settings
+     *
+     * @throws {RequiredError}
+     */
+    getSettings(requestParameters?: TenantSettingsRouteRequest, initOverrides?: InitOverride): Promise<ApiResponse<TenantSettings>>;
+}
+export {};

package/dist/esm/management/__generated/managers/tickets-manager.d.ts

@@ -0,0 +1,24 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { PostEmailVerification201Response, PostEmailVerificationRequest, PostPasswordChange201Response, PostPasswordChangeRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class TicketsManager extends BaseAPI {
+    /**
+     * Create a <a href="https://auth0.com/docs/email/custom#verification-email">ticket to verify a user's email address</a>.
+     * Create an email verification ticket
+     *
+     * @throws {RequiredError}
+     */
+    verifyEmail(bodyParameters: PostEmailVerificationRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostEmailVerification201Response>>;
+    /**
+     * Create a <a href="https://auth0.com/docs/connections/database/password-change">password change ticket</a> for a user.
+     * Create a password change ticket
+     *
+     * @throws {RequiredError}
+     */
+    changePassword(bodyParameters: PostPasswordChangeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostPasswordChange201Response>>;
+}
+export {};

package/dist/esm/management/__generated/managers/user-blocks-manager.d.ts

@@ -0,0 +1,45 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { UserBlock, DeleteUserBlocksRequest, DeleteUserBlocksByIdRequest, GetUserBlocksRequest, GetUserBlocksByIdRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class UserBlocksManager extends BaseAPI {
+    /**
+     * Unblock a user blocked due to an excessive amount of incorrectly-provided credentials.
+     *
+     * Unblock by identifier
+     *
+     * @throws {RequiredError}
+     */
+    deleteAll(requestParameters: DeleteUserBlocksRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Unblock a user that was blocked due to an excessive amount of incorrectly provided credentials.
+     *
+     * Note: This endpoint does not unblock users that were <a href="https://auth0.com/docs/user-profile#block-and-unblock-a-user">blocked by admins</a>.
+     *
+     * Unblock a user
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteUserBlocksByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve a list of blocked IP addresses for a given identifier (e.g., username, phone number or email).
+     *
+     * Get blocks by identifier
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters: GetUserBlocksRequest, initOverrides?: InitOverride): Promise<ApiResponse<UserBlock>>;
+    /**
+     * Retrieve a list of blocked IP addresses for the login identifiers (email, username, phone number, etc) associated with the specified user.
+     *
+     *
+     * Get a user's blocks
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetUserBlocksByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<UserBlock>>;
+}
+export {};

package/dist/esm/management/__generated/managers/users-by-email-manager.d.ts

@@ -0,0 +1,22 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { GetUsers200ResponseOneOfInner, GetUsersByEmailRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class UsersByEmailManager extends BaseAPI {
+    /**
+     * If Auth0 is the identify provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it. For example, if you register a user as <b>JohnSmith@example.com</b>, Auth0 saves the user's email as <b>johnsmith@example.com</b>.
+     *
+     * In cases where Auth0 is not the idP, the `email` is stored based on the rules of idP, so make sure the search is made using the correct capitalization.
+     *
+     * When using this endpoint, make sure that you are searching for users via email addresses using the correct case.
+     *
+     * Search Users by Email
+     *
+     * @throws {RequiredError}
+     */
+    getByEmail(requestParameters: GetUsersByEmailRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetUsers200ResponseOneOfInner>>>;
+}
+export {};