auth0 4.0.0-beta.0 → 4.0.0-beta.10

package/dist/esm/management/__generated/managers/grants-manager.js

@@ -0,0 +1,77 @@
+import * as runtime from '../../../lib/runtime.js';
+const { BaseAPI } = runtime;
+/**
+ *
+ */
+export class GrantsManager extends BaseAPI {
+    /**
+     * Delete a grant associated with your account.
+     * Delete a grant by id
+     *
+     * @throws {RequiredError}
+     */
+    async delete(requestParameters, initOverrides) {
+        runtime.validateRequiredRequestParams(requestParameters, ['id']);
+        const response = await this.request({
+            path: `/grants/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
+            method: 'DELETE',
+        }, initOverrides);
+        return runtime.VoidApiResponse.fromResponse(response);
+    }
+    /**
+     * Delete a grant associated with your account.
+     * Delete a grant by user_id
+     *
+     * @throws {RequiredError}
+     */
+    async deleteByUserId(requestParameters, initOverrides) {
+        runtime.validateRequiredRequestParams(requestParameters, ['user_id']);
+        const queryParameters = runtime.applyQueryParams(requestParameters, [
+            {
+                key: 'user_id',
+                config: {},
+            },
+        ]);
+        const response = await this.request({
+            path: `/grants/`,
+            method: 'DELETE',
+            query: queryParameters,
+        }, initOverrides);
+        return runtime.VoidApiResponse.fromResponse(response);
+    }
+    async getAll(requestParameters = {}, initOverrides) {
+        const queryParameters = runtime.applyQueryParams(requestParameters, [
+            {
+                key: 'per_page',
+                config: {},
+            },
+            {
+                key: 'page',
+                config: {},
+            },
+            {
+                key: 'include_totals',
+                config: {},
+            },
+            {
+                key: 'user_id',
+                config: {},
+            },
+            {
+                key: 'client_id',
+                config: {},
+            },
+            {
+                key: 'audience',
+                config: {},
+            },
+        ]);
+        const response = await this.request({
+            path: `/grants`,
+            method: 'GET',
+            query: queryParameters,
+        }, initOverrides);
+        return runtime.JSONApiResponse.fromResponse(response);
+    }
+}
+//# sourceMappingURL=grants-manager.js.map

package/dist/esm/management/__generated/managers/grants-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grants-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/grants-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAWnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,OAAO;IACxC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,iBAA0C,EAC1C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YACtF,MAAM,EAAE,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,iBAA8C,EAC9C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QAEtE,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,SAAS;gBACd,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAgBD,KAAK,CAAC,MAAM,CACV,oBAAsC,EAAE,EACxC,aAA4B;QAE5B,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,SAAS;gBACd,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,WAAW;gBAChB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF"}

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

@@ -0,0 +1,240 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { Enrollment, EnrollmentCreate, Factor, GetApns200Response, GetMessageTypes200Response, GetPhoneProviders200Response, GetPnProviders200Response, PostTicket200Response, PutApns200Response, PutApnsRequest, PutFactorsByName200Response, PutFactorsByNameRequest, PutFcmRequest, PutSns200Response, PutSnsRequest, PutTwilioRequest, SmsTwilioFactorProvider, SnsFactorProvider, TemplateMessages, TwilioFactorProvider, DeleteEnrollmentsByIdRequest, GetEnrollmentsByIdRequest, PutFactorsByNameOperationRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class GuardianManager extends BaseAPI {
+    /**
+     * Delete an enrollment to allow the user to enroll with multi-factor authentication again.
+     * Delete a multi-factor authentication enrollment
+     *
+     * @throws {RequiredError}
+     */
+    deleteGuardianEnrollment(requestParameters: DeleteEnrollmentsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve APNS push notification configuration
+     *
+     * @throws {RequiredError}
+     */
+    getPushNotificationProviderAPNS(initOverrides?: InitOverride): Promise<ApiResponse<GetApns200Response>>;
+    /**
+     * Retrieve an enrollment (including its status and type).
+     *
+     * Note: Phone numbers are partially obfuscated.
+     * Retrieve a multi-factor authentication enrollment
+     *
+     * @throws {RequiredError}
+     */
+    getGuardianEnrollment(requestParameters: GetEnrollmentsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Enrollment>>;
+    /**
+     * Retrieve phone enrollment and verification templates (subscription required).
+     * Retrieve Enrollment and Verification Phone Templates
+     *
+     * @throws {RequiredError}
+     */
+    getPhoneFactorTemplates(initOverrides?: InitOverride): Promise<ApiResponse<TemplateMessages>>;
+    /**
+     * Retrieve SMS enrollment and verification templates (subscription required).
+     *
+     *     A new endpoint is available to retrieve enrollment and verification templates related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/get_templates'>phone templates</a>). It has the same payload as this one. Please use it instead.
+     * Retrieve SMS Enrollment and Verification Templates
+     *
+     * @throws {RequiredError}
+     */
+    getSmsFactorTemplates(initOverrides?: InitOverride): Promise<ApiResponse<TemplateMessages | void>>;
+    /**
+     * Retrieve all <a href="https://auth0.com/docs/multifactor-authentication">multi-factor authentication</a> configurations.
+     * Retrieve Factors and their Status
+     *
+     * @throws {RequiredError}
+     */
+    getFactors(initOverrides?: InitOverride): Promise<ApiResponse<Array<Factor>>>;
+    /**
+     * Retrieve the Enabled Phone Factors
+     *
+     * @throws {RequiredError}
+     */
+    getPhoneFactorMessageTypes(initOverrides?: InitOverride): Promise<ApiResponse<GetMessageTypes200Response>>;
+    /**
+     * Retrieve phone configuration (one of auth0|twilio|phone-message-hook)
+     *
+     * @throws {RequiredError}
+     */
+    getPhoneFactorSelectedProvider(initOverrides?: InitOverride): Promise<ApiResponse<GetPhoneProviders200Response>>;
+    /**
+     * Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio phone provider configuration</a> (subscription required).
+     * Retrieve Twilio phone configuration
+     *
+     * @throws {RequiredError}
+     */
+    getPhoneFactorProviderTwilio(initOverrides?: InitOverride): Promise<ApiResponse<TwilioFactorProvider>>;
+    /**
+     * Retrieve push notification provider
+     *
+     * @throws {RequiredError}
+     */
+    getPushNotificationSelectedProvider(initOverrides?: InitOverride): Promise<ApiResponse<GetPnProviders200Response>>;
+    /**
+     * Gets the MFA policies for the tenant.
+     *
+     * The following policies are supported: <ul><li><code>all-applications</code> policy - will prompt with MFA for all logins.</li><li><code>confidence-score</code> policy - will prompt with MFA only for low confidence logins.</li></ul>
+     * Use of the Adaptive MFA feature requires an add-on for the Enterprise plan. Please contact sales with any questions. For more information about Adaptive MFA, read our <a href="https://auth0.com/docs/mfa/adaptive-mfa">full documentation</a>.
+     *
+     * Get the Multi-factor Authentication policies
+     *
+     * @throws {RequiredError}
+     */
+    getPolicies(initOverrides?: InitOverride): Promise<ApiResponse<Array<string>>>;
+    /**
+     * A new endpoint is available to retrieve the configuration related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/get_selected_provider'>phone configuration</a>). It has the same payload as this one. Please use it instead.
+     * Retrieve SMS configuration (one of auth0|twilio|phone-message-hook)
+     *
+     * @throws {RequiredError}
+     */
+    getSmsSelectedProvider(initOverrides?: InitOverride): Promise<ApiResponse<GetPhoneProviders200Response>>;
+    /**
+     * Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio SMS provider configuration</a> (subscription required).
+     *
+     *     A new endpoint is available to retrieve the Twilio configuration related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/get_twilio'>phone Twilio configuration</a>). It has the same payload as this one. Please use it instead.
+     * Retrieve Twilio SMS configuration
+     *
+     * @throws {RequiredError}
+     */
+    getSmsFactorProviderTwilio(initOverrides?: InitOverride): Promise<ApiResponse<SmsTwilioFactorProvider>>;
+    /**
+     * Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/developer/sns-configuration">AWS SNS push notification provider configuration</a> (subscription required).
+     * Retrieve AWS SNS push notification configuration
+     *
+     * @throws {RequiredError}
+     */
+    getPushNotificationProviderSNS(initOverrides?: InitOverride): Promise<ApiResponse<SnsFactorProvider>>;
+    /**
+     * Updates APNs provider configuration
+     *
+     * @throws {RequiredError}
+     */
+    updatePushNotificationProviderAPNS(bodyParameters: PutApnsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutApns200Response>>;
+    /**
+     * Updates FCM provider configuration
+     *
+     * @throws {RequiredError}
+     */
+    updatePushNotificationProviderFCM(bodyParameters: PutFcmRequest, initOverrides?: InitOverride): Promise<ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Configure the <a href="https://auth0.com/docs/multifactor-authentication/developer/sns-configuration">AWS SNS push notification provider configuration</a> (subscription required).
+     * Update SNS configuration for push notifications
+     *
+     * @throws {RequiredError}
+     */
+    updatePushNotificationProviderSNS(bodyParameters: PutSnsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutSns200Response>>;
+    /**
+     * Generate an email with a link to start the multi-factor authentication enrollment process (subscription required).
+     * Create a multi-factor authentication enrollment ticket
+     *
+     * @throws {RequiredError}
+     */
+    createEnrollmentTicket(bodyParameters: EnrollmentCreate, initOverrides?: InitOverride): Promise<ApiResponse<PostTicket200Response>>;
+    /**
+     * Updates APNs provider configuration
+     *
+     * @throws {RequiredError}
+     */
+    setPushNotificationProviderAPNS(bodyParameters: PutApnsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutApns200Response>>;
+    /**
+     * Customize the messages sent to complete phone enrollment and verification (subscription required).
+     * Update Enrollment and Verification Phone Templates
+     *
+     * @throws {RequiredError}
+     */
+    setPhoneFactorTemplates(bodyParameters: TemplateMessages, initOverrides?: InitOverride): Promise<ApiResponse<TemplateMessages>>;
+    /**
+     * Customize the messages sent to complete SMS enrollment and verification (subscription required).
+     *
+     *     A new endpoint is available to update enrollment and verification templates related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/put_templates'>phone templates</a>). It has the same payload as this one. Please use it instead.
+     * Update SMS Enrollment and Verification Templates
+     *
+     * @throws {RequiredError}
+     */
+    setSmsFactorTemplates(bodyParameters: TemplateMessages, initOverrides?: InitOverride): Promise<ApiResponse<TemplateMessages>>;
+    /**
+     * Update a multi-factor authentication factor (subscription required).
+     * Update a Multi-factor Authentication Factor
+     *
+     * @throws {RequiredError}
+     */
+    updateFactor(requestParameters: PutFactorsByNameOperationRequest, bodyParameters: PutFactorsByNameRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutFactorsByName200Response>>;
+    /**
+     * Updates FCM provider configuration
+     *
+     * @throws {RequiredError}
+     */
+    setPushNotificationProviderFCM(bodyParameters: PutFcmRequest, initOverrides?: InitOverride): Promise<ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Update enabled phone factors for multi-factor authentication
+     * Update the Enabled Phone Factors
+     *
+     * @throws {RequiredError}
+     */
+    updatePhoneFactorMessageTypes(bodyParameters: GetMessageTypes200Response, initOverrides?: InitOverride): Promise<ApiResponse<GetMessageTypes200Response>>;
+    /**
+     * Update phone configuration (one of auth0|twilio|phone-message-hook)
+     *
+     * @throws {RequiredError}
+     */
+    updatePhoneFactorSelectedProvider(bodyParameters: GetPhoneProviders200Response, initOverrides?: InitOverride): Promise<ApiResponse<GetPhoneProviders200Response>>;
+    /**
+     * Update Push Notification configuration (one of direct|sns|guardian)
+     *
+     * @throws {RequiredError}
+     */
+    setPushNotificationSelectedProvider(bodyParameters: GetPnProviders200Response, initOverrides?: InitOverride): Promise<ApiResponse<GetPnProviders200Response>>;
+    /**
+     * Sets the MFA policies for the tenant.
+     *
+     * The following policies are supported: <ul><li><code>all-applications</code> policy - will prompt with MFA for all logins.</li><li><code>confidence-score</code> policy - will prompt with MFA only for low confidence logins.</li></ul> Pass an empty array to remove all MFA policies.
+     * Use of the Adaptive MFA feature requires an add-on for the Enterprise plan. Please contact sales with any questions. For more information about Adaptive MFA, read our <a href="https://auth0.com/docs/mfa/adaptive-mfa">full documentation</a>.
+     *
+     *
+     * Set the Multi-factor Authentication policies
+     *
+     * @throws {RequiredError}
+     */
+    updatePolicies(bodyParameters: Array<string>, initOverrides?: InitOverride): Promise<ApiResponse<Array<string>>>;
+    /**
+     * A new endpoint is available to update the configuration related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/put_selected_provider'>phone configuration</a>). It has the same payload as this one. Please use it instead.
+     * Update SMS configuration (one of auth0|twilio|phone-message-hook)
+     *
+     * @throws {RequiredError}
+     */
+    setSmsSelectedProvider(bodyParameters: GetPhoneProviders200Response, initOverrides?: InitOverride): Promise<ApiResponse<GetPhoneProviders200Response>>;
+    /**
+     * Configure the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio SMS provider configuration</a> (subscription required).
+     *
+     *     A new endpoint is available to update the Twilio configuration related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/put_twilio'>phone Twilio configuration</a>). It has the same payload as this one. Please use it instead.
+     * Update Twilio SMS configuration
+     *
+     * @throws {RequiredError}
+     */
+    setSmsFactorProviderTwilio(bodyParameters: PutTwilioRequest, initOverrides?: InitOverride): Promise<ApiResponse<SmsTwilioFactorProvider>>;
+    /**
+     * Configure the <a href="https://auth0.com/docs/multifactor-authentication/developer/sns-configuration">AWS SNS push notification provider configuration</a> (subscription required).
+     * Update AWS SNS push notification configuration
+     *
+     * @throws {RequiredError}
+     */
+    setPushNotificationProviderSNS(bodyParameters: PutSnsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutSns200Response>>;
+    /**
+     * Configure the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio phone provider configuration</a> (subscription required).
+     * Update Twilio phone configuration
+     *
+     * @throws {RequiredError}
+     */
+    updatePhoneFactorProviderTwilio(bodyParameters: PutTwilioRequest, initOverrides?: InitOverride): Promise<ApiResponse<TwilioFactorProvider>>;
+}
+export {};