{
  "opencollection": "1.0.0",
  "info": {
    "name": "Auth0 Authentication actions guardian API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "guardian",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a Multi-factor Authentication Enrollment Ticket",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/guardian/enrollments/ticket",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/auth0-guardian/create-custom-enrollment-tickets\">multi-factor authentication (MFA) enrollment ticket</a>, and optionally send an email with the created ticket, to a given user.\nCreate a <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/auth0-guardian/create-custom-enrollment-tickets\">multi-factor authentication (MFA) enrollment ticket</a>, and optionally send an email with the created ticket to a given u"
        },
        {
          "info": {
            "name": "Get a Multi-factor Authentication Enrollment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/enrollments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the enrollment to be retrieve."
              }
            ]
          },
          "docs": "Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account."
        },
        {
          "info": {
            "name": "Delete a Multi-factor Authentication Enrollment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{auth0_domain}/guardian/enrollments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the enrollment to be deleted."
              }
            ]
          },
          "docs": "Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA. For more information, review <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa\">Reset User Multi-Factor Authentication and Recovery Codes</a>."
        },
        {
          "info": {
            "name": "Get Factors and Multi-factor Authentication Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors"
          },
          "docs": "Retrieve details of all <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors\">multi-factor authentication factors</a> associated with your tenant."
        },
        {
          "info": {
            "name": "Get DUO Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/duo/settings"
          },
          "docs": "Retrieves the DUO account and factor configuration."
        },
        {
          "info": {
            "name": "Set the DUO Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/duo/settings",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set the DUO account configuration and other properties specific to this factor."
        },
        {
          "info": {
            "name": "Update the DUO Configuration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/guardian/factors/duo/settings",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the DUO Configuration"
        },
        {
          "info": {
            "name": "Get Enabled Phone Factors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/phone/message-types"
          },
          "docs": "Retrieve list of <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-sms-voice-notifications-mfa\">phone-type MFA factors</a> (i.e., sms and voice) that are enabled for your tenant."
        },
        {
          "info": {
            "name": "Update the Enabled Phone Factors",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/phone/message-types",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace the list of <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-sms-voice-notifications-mfa\">phone-type MFA factors</a> (i.e., sms and voice) that are enabled for your tenant."
        },
        {
          "info": {
            "name": "Get Twilio Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/phone/providers/twilio"
          },
          "docs": "Retrieve configuration details for a Twilio phone provider that has been set up in your tenant. To learn more, review <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-sms-voice-notifications-mfa\">Configure SMS and Voice Notifications for MFA</a>. "
        },
        {
          "info": {
            "name": "Update Twilio Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/phone/providers/twilio",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the configuration of a Twilio phone provider that has been set up in your tenant. To learn more, review <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-sms-voice-notifications-mfa\">Configure SMS and Voice Notifications for MFA</a>. "
        },
        {
          "info": {
            "name": "Get Phone Provider Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/phone/selected-provider"
          },
          "docs": "Retrieve details of the multi-factor authentication phone provider configured for your tenant."
        },
        {
          "info": {
            "name": "Update Phone Provider Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/phone/selected-provider",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update Phone Provider Configuration"
        },
        {
          "info": {
            "name": "Get Enrollment and Verification Phone Templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/phone/templates"
          },
          "docs": "Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant."
        },
        {
          "info": {
            "name": "Update Enrollment and Verification Phone Templates",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/phone/templates",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Customize the messages sent to complete phone enrollment and verification (subscription required)."
        },
        {
          "info": {
            "name": "Get APNS Push Notification Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/apns"
          },
          "docs": "Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant."
        },
        {
          "info": {
            "name": "Update APNS Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/apns",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant."
        },
        {
          "info": {
            "name": "Update APNs Provider Configuration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/apns",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify configuration details of the multi-factor authentication APNS provider associated with your tenant."
        },
        {
          "info": {
            "name": "Overwrite FCM Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/fcm",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant."
        },
        {
          "info": {
            "name": "Updates FCM Configuration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/fcm",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify configuration details of the multi-factor authentication FCM provider associated with your tenant."
        },
        {
          "info": {
            "name": "Overwrite FCMV1 Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/fcmv1",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant."
        },
        {
          "info": {
            "name": "Updates FCMV1 Configuration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/fcmv1",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant."
        },
        {
          "info": {
            "name": "Get AWS SNS Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/sns"
          },
          "docs": "Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa\">Configure Push Notifications for MFA</a>. "
        },
        {
          "info": {
            "name": "Configure AWS SNS Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/sns",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Configure the <a href=\"https://auth0.com/docs/multifactor-authentication/developer/sns-configuration\">AWS SNS push notification provider configuration</a> (subscription required)."
        },
        {
          "info": {
            "name": "Update AWS SNS Configuration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/guardian/factors/push-notification/providers/sns",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Configure the <a href=\"https://auth0.com/docs/multifactor-authentication/developer/sns-configuration\">AWS SNS push notification provider configuration</a> (subscription required)."
        },
        {
          "info": {
            "name": "Get Push Notification Provider",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/push-notification/selected-provider"
          },
          "docs": "Modify the push notification provider configured for your tenant. For more information, review <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa\">Configure Push Notifications for MFA</a>. "
        },
        {
          "info": {
            "name": "Update Push Notification Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/push-notification/selected-provider",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify the push notification provider configured for your tenant. For more information, review <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-factors/configure-push-notifications-for-mfa\">Configure Push Notifications for MFA</a>. "
        },
        {
          "info": {
            "name": "Get Twilio SMS Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/sms/providers/twilio"
          },
          "docs": "Retrieve the <a href=\"https://auth0.com/docs/multifactor-authentication/twilio-configuration\">Twilio SMS provider configuration</a> (subscription required).\n\n    A new endpoint is available to retrieve the Twilio configuration related to phone factors (<a href='https://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."
        },
        {
          "info": {
            "name": "Update Twilio SMS Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/sms/providers/twilio",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint has been deprecated. To complete this action, use the <a href=\"https://auth0.com/docs/api/management/v2/guardian/put-twilio\">Update Twilio phone configuration</a> endpoint.\n\n    <b>Previous functionality</b>: Update the Twilio SMS provider configuration."
        },
        {
          "info": {
            "name": "Get SMS Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/sms/selected-provider"
          },
          "docs": "This endpoint has been deprecated. To complete this action, use the <a href=\"https://auth0.com/docs/api/management/v2/guardian/get-phone-providers\">Retrieve phone configuration</a> endpoint instead.\n\n    <b>Previous functionality</b>: Retrieve details for the multi-factor authentication SMS provider configured for your tenant."
        },
        {
          "info": {
            "name": "Update SMS Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/sms/selected-provider",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint has been deprecated. To complete this action, use the <a href=\"https://auth0.com/docs/api/management/v2/guardian/put-phone-providers\">Update phone configuration</a> endpoint instead.\n\n    <b>Previous functionality</b>: Update the multi-factor authentication SMS provider configuration in your tenant."
        },
        {
          "info": {
            "name": "Get SMS Enrollment and Verification Templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/factors/sms/templates"
          },
          "docs": "This endpoint has been deprecated. To complete this action, use the <a href=\"https://auth0.com/docs/api/management/v2/guardian/get-factor-phone-templates\">Retrieve enrollment and verification phone templates</a> endpoint instead.\n\n    <b>Previous function</b>: Retrieve details of SMS enrollment and verification templates configured for your tenant."
        },
        {
          "info": {
            "name": "Update SMS Enrollment and Verification Templates",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/sms/templates",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint has been deprecated. To complete this action, use the <a href=\"https://auth0.com/docs/api/management/v2/guardian/put-factor-phone-templates\">Update enrollment and verification phone templates</a> endpoint instead.\n\n    <b>Previous functionality</b>: Customize the messages sent to complete SMS enrollment and verification."
        },
        {
          "info": {
            "name": "Update Multi-factor Authentication Type",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/factors/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor."
        },
        {
          "info": {
            "name": "Get Multi-factor Authentication Policies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/guardian/policies"
          },
          "docs": "Retrieve the <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa\">multi-factor authentication (MFA) policies</a> configured for your tenant.\n\nThe following policies are supported:\n<ul>\n<li><code>all-applications</code> policy prompts with MFA for all logins.</li>\n<li><code>confidence-score</code> policy prompts with MFA only for low confidence logins.</li>\n</ul>\n\n<b>Note</b>: The <code>confidence-score</code> policy is part of the <a href=\"https://auth0.com/docs/secure/"
        },
        {
          "info": {
            "name": "Update Multi-factor Authentication Policies",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/guardian/policies",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa\">multi-factor authentication (MFA) policies</a> for your tenant.\n\nThe following policies are supported:\n<ul>\n<li><code>all-applications</code> policy prompts with MFA for all logins.</li>\n<li><code>confidence-score</code> policy prompts with MFA only for low confidence logins.</li>\n</ul>\n\n<b>Note</b>: The <code>confidence-score</code> policy is part of the <a href=\"https://auth0.com/docs/secure/multi-factor-authent"
        }
      ]
    }
  ],
  "bundled": true
}