auth0/dist/esm/management/__generated/managers/guardian-manager.js

SDK for Auth0 API v2

import * as runtime from '../../../lib/runtime.js';
const { BaseAPI } = runtime;
/**
 *
 */
export 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}
     */
    async deleteGuardianEnrollment(requestParameters, initOverrides) {
        runtime.validateRequiredRequestParams(requestParameters, ['id']);
        const response = await this.request({
            path: `/guardian/enrollments/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
            method: 'DELETE',
        }, initOverrides);
        return runtime.VoidApiResponse.fromResponse(response);
    }
    /**
     * Retrieve APNS push notification configuration
     *
     * @throws {RequiredError}
     */
    async getPushNotificationProviderAPNS(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/push-notification/providers/apns`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Retrieve an enrollment (including its status and type).
     *
     * Note: Phone numbers are partially obfuscated.
     * Retrieve a multi-factor authentication enrollment
     *
     * @throws {RequiredError}
     */
    async getGuardianEnrollment(requestParameters, initOverrides) {
        runtime.validateRequiredRequestParams(requestParameters, ['id']);
        const response = await this.request({
            path: `/guardian/enrollments/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Retrieve phone enrollment and verification templates (subscription required).
     * Retrieve Enrollment and Verification Phone Templates
     *
     * @throws {RequiredError}
     */
    async getPhoneFactorTemplates(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/phone/templates`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async getSmsFactorTemplates(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/sms/templates`,
            method: 'GET',
        }, initOverrides);
        return response.status === 204
            ? runtime.VoidApiResponse.fromResponse(response)
            : runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Retrieve all <a href="https://auth0.com/docs/multifactor-authentication">multi-factor authentication</a> configurations.
     * Retrieve Factors and their Status
     *
     * @throws {RequiredError}
     */
    async getFactors(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Retrieve the Enabled Phone Factors
     *
     * @throws {RequiredError}
     */
    async getPhoneFactorMessageTypes(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/phone/message-types`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Retrieve phone configuration (one of auth0|twilio|phone-message-hook)
     *
     * @throws {RequiredError}
     */
    async getPhoneFactorSelectedProvider(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/phone/selected-provider`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async getPhoneFactorProviderTwilio(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/phone/providers/twilio`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Retrieve push notification provider
     *
     * @throws {RequiredError}
     */
    async getPushNotificationSelectedProvider(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/push-notification/selected-provider`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async getPolicies(initOverrides) {
        const response = await this.request({
            path: `/guardian/policies`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async getSmsSelectedProvider(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/sms/selected-provider`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async getSmsFactorProviderTwilio(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/sms/providers/twilio`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async getPushNotificationProviderSNS(initOverrides) {
        const response = await this.request({
            path: `/guardian/factors/push-notification/providers/sns`,
            method: 'GET',
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Updates APNs provider configuration
     *
     * @throws {RequiredError}
     */
    async updatePushNotificationProviderAPNS(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/push-notification/providers/apns`,
            method: 'PATCH',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Updates FCM provider configuration
     *
     * @throws {RequiredError}
     */
    async updatePushNotificationProviderFCM(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/push-notification/providers/fcm`,
            method: 'PATCH',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async updatePushNotificationProviderSNS(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/push-notification/providers/sns`,
            method: 'PATCH',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async createEnrollmentTicket(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/enrollments/ticket`,
            method: 'POST',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Updates APNs provider configuration
     *
     * @throws {RequiredError}
     */
    async setPushNotificationProviderAPNS(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/push-notification/providers/apns`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Customize the messages sent to complete phone enrollment and verification (subscription required).
     * Update Enrollment and Verification Phone Templates
     *
     * @throws {RequiredError}
     */
    async setPhoneFactorTemplates(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/phone/templates`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async setSmsFactorTemplates(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/sms/templates`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Update a multi-factor authentication factor (subscription required).
     * Update a Multi-factor Authentication Factor
     *
     * @throws {RequiredError}
     */
    async updateFactor(requestParameters, bodyParameters, initOverrides) {
        runtime.validateRequiredRequestParams(requestParameters, ['name']);
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/{name}`.replace('{name}', encodeURIComponent(String(requestParameters.name))),
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Updates FCM provider configuration
     *
     * @throws {RequiredError}
     */
    async setPushNotificationProviderFCM(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/push-notification/providers/fcm`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Update enabled phone factors for multi-factor authentication
     * Update the Enabled Phone Factors
     *
     * @throws {RequiredError}
     */
    async updatePhoneFactorMessageTypes(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/phone/message-types`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Update phone configuration (one of auth0|twilio|phone-message-hook)
     *
     * @throws {RequiredError}
     */
    async updatePhoneFactorSelectedProvider(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/phone/selected-provider`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * Update Push Notification configuration (one of direct|sns|guardian)
     *
     * @throws {RequiredError}
     */
    async setPushNotificationSelectedProvider(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/push-notification/selected-provider`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async updatePolicies(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/policies`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async setSmsSelectedProvider(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/sms/selected-provider`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async setSmsFactorProviderTwilio(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/sms/providers/twilio`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async setPushNotificationProviderSNS(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/push-notification/providers/sns`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
    /**
     * 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}
     */
    async updatePhoneFactorProviderTwilio(bodyParameters, initOverrides) {
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        const response = await this.request({
            path: `/guardian/factors/phone/providers/twilio`,
            method: 'PUT',
            headers: headerParameters,
            body: bodyParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
}
//# sourceMappingURL=guardian-manager.js.map