Auth0 guardian API

openapi: 3.0.0
info:
  title: Auth0 Authentication actions guardian API
  description: Auth0 Authentication API. Endpoints for authentication and authorization using OpenID Connect, OAuth 2.0, SAML, WS-Federation, and Passwordless flows.
  version: 1.0.0
servers:
- url: '{auth0_domain}'
  description: The Authentication API is served over HTTPS.
  variables:
    auth0_domain:
      description: Auth0 domain
      default: https://demo.us.auth0.com
tags:
- name: guardian
paths:
  /guardian/enrollments/ticket:
    post:
      summary: Create a Multi-factor Authentication Enrollment Ticket
      description: "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 user. Enrollment tickets can specify which factor users must enroll with or allow existing MFA users to enroll in additional factors.<br/> \n\nNote: Users cannot enroll in Email as a factor through custom enrollment tickets. \n"
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGuardianEnrollmentTicketRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateGuardianEnrollmentTicketRequestContent'
      responses:
        '200':
          description: Enrollment ticket successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGuardianEnrollmentTicketResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
        '404':
          description: User not found.
      operationId: post_ticket
      x-release-lifecycle: GA
      x-operation-name: createTicket
      x-operation-group:
      - guardian
      - enrollments
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:guardian_enrollment_tickets
  /guardian/enrollments/{id}:
    get:
      summary: Get a Multi-factor Authentication Enrollment
      description: Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.
      tags:
      - guardian
      parameters:
      - name: id
        in: path
        description: ID of the enrollment to be retrieve.
        required: true
        schema:
          type: string
          pattern: ^((totp|sms|voice|push|email|recovery-code|webauthn-roaming|webauthn-platform)\|)?dev_[A-Za-z0-9-_]+$
      responses:
        '200':
          description: Enrollment successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianEnrollmentResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_enrollments_by_id
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-group:
      - guardian
      - enrollments
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_enrollments
    delete:
      summary: Delete a Multi-factor Authentication Enrollment
      description: 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>.
      tags:
      - guardian
      parameters:
      - name: id
        in: path
        description: ID of the enrollment to be deleted.
        required: true
        schema:
          type: string
          pattern: ^((totp|sms|voice|push|email|recovery-code|webauthn-roaming|webauthn-platform)\|)?dev_[A-Za-z0-9-_]+$
      responses:
        '204':
          description: Enrollment successfully deleted.
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope (expected delete:enrollment).
      operationId: delete_enrollments_by_id
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group:
      - guardian
      - enrollments
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:guardian_enrollments
  /guardian/factors:
    get:
      summary: Get Factors and Multi-factor Authentication Details
      description: 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.
      tags:
      - guardian
      responses:
        '200':
          description: Factors successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GuardianFactor'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_factors
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListFactorsRequestParameters
      x-operation-group:
      - guardian
      - factors
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
  /guardian/factors/duo/settings:
    get:
      summary: Get DUO Configuration
      description: Retrieves the DUO account and factor configuration.
      tags:
      - guardian
      responses:
        '200':
          description: DUO settings successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorDuoSettingsResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_factor_duo_settings
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-group:
      - guardian
      - factors
      - duo
      - settings
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    patch:
      summary: Update the DUO Configuration
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorDuoSettingsRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorDuoSettingsRequestContent'
      responses:
        '200':
          description: DUO settings successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGuardianFactorDuoSettingsResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: patch_factor_duo_settings
      x-release-lifecycle: GA
      x-operation-name: update
      x-operation-group:
      - guardian
      - factors
      - duo
      - settings
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
    put:
      summary: Set the DUO Configuration
      description: Set the DUO account configuration and other properties specific to this factor.
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorDuoSettingsRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorDuoSettingsRequestContent'
      responses:
        '200':
          description: DUO settings successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorDuoSettingsResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: put_factor_duo_settings
      x-release-lifecycle: GA
      x-operation-name: set
      x-operation-group:
      - guardian
      - factors
      - duo
      - settings
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/phone/message-types:
    get:
      summary: Get Enabled Phone Factors
      description: 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.
      tags:
      - guardian
      responses:
        '200':
          description: Returns the enabled phone factors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorPhoneMessageTypesResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: get_message-types
      x-release-lifecycle: GA
      x-operation-name: getMessageTypes
      x-operation-group:
      - guardian
      - factors
      - phone
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    put:
      summary: Update the Enabled Phone Factors
      description: 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.
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorPhoneMessageTypesRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorPhoneMessageTypesRequestContent'
      responses:
        '200':
          description: Returns selected SMS provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorPhoneMessageTypesResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
        '404':
          description: The phone factor does not exist.
      operationId: put_message-types
      x-release-lifecycle: GA
      x-operation-name: setMessageTypes
      x-operation-group:
      - guardian
      - factors
      - phone
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/phone/providers/twilio:
    get:
      summary: Get Twilio Configuration
      description: '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>. '
      tags:
      - guardian
      responses:
        '200':
          description: Twilio Phone configuration successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorsProviderPhoneTwilioResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_phone_twilio_factor_provider
      x-release-lifecycle: GA
      x-operation-name: getTwilioProvider
      x-operation-group:
      - guardian
      - factors
      - phone
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    put:
      summary: Update Twilio Configuration
      description: '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>. '
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPhoneTwilioRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPhoneTwilioRequestContent'
      responses:
        '200':
          description: Twilio Phone configuration successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderPhoneTwilioResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: put_twilio
      x-release-lifecycle: GA
      x-operation-name: setTwilioProvider
      x-operation-group:
      - guardian
      - factors
      - phone
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/phone/selected-provider:
    get:
      summary: Get Phone Provider Configuration
      description: Retrieve details of the multi-factor authentication phone provider configured for your tenant.
      tags:
      - guardian
      responses:
        '200':
          description: Returns selected Phone provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorsProviderPhoneResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: get_guardian_phone_providers
      x-release-lifecycle: GA
      x-operation-name: getSelectedProvider
      x-operation-group:
      - guardian
      - factors
      - phone
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    put:
      summary: Update Phone Provider Configuration
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPhoneRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPhoneRequestContent'
      responses:
        '200':
          description: Returns selected Phone provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderPhoneResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: put_phone_providers
      x-release-lifecycle: GA
      x-operation-name: setProvider
      x-operation-group:
      - guardian
      - factors
      - phone
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/phone/templates:
    get:
      summary: Get Enrollment and Verification Phone Templates
      description: Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.
      tags:
      - guardian
      responses:
        '200':
          description: Phone enrollment and verification templates successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorPhoneTemplatesResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_factor_phone_templates
      x-release-lifecycle: GA
      x-operation-name: getTemplates
      x-operation-group:
      - guardian
      - factors
      - phone
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    put:
      summary: Update Enrollment and Verification Phone Templates
      description: Customize the messages sent to complete phone enrollment and verification (subscription required).
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorPhoneTemplatesRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorPhoneTemplatesRequestContent'
      responses:
        '200':
          description: Phone enrollment and verification templates successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorPhoneTemplatesResponseContent'
        '400':
          description: Invalid input based on schemas.
          x-description-1: 'Invalid <enrollment_message/verification_message> template: <error details>.'
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: put_factor_phone_templates
      x-release-lifecycle: GA
      x-operation-name: setTemplates
      x-operation-group:
      - guardian
      - factors
      - phone
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/push-notification/providers/apns:
    get:
      summary: Get APNS Push Notification Configuration
      description: Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant.
      tags:
      - guardian
      responses:
        '200':
          description: APNS configuration successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorsProviderApnsResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_apns
      x-release-lifecycle: GA
      x-operation-name: getApnsProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    patch:
      summary: Update APNs Provider Configuration
      description: Modify configuration details of the multi-factor authentication APNS provider associated with your tenant.
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationApnsRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationApnsRequestContent'
      responses:
        '200':
          description: APNS configuration successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationApnsResponseContent'
        '400':
          description: Invalid input based on schemas.
          x-description-1: 'The PKCS #12 file is invalid. Please ensure the client certificate is not expired, the environment matches, and the key and certificate are not encrypted with a deprecated algorithm.'
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: patch_apns
      x-release-lifecycle: GA
      x-operation-name: updateApnsProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
    put:
      summary: Update APNS Configuration
      description: Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationApnsRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationApnsRequestContent'
      responses:
        '200':
          description: APNS configuration successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationApnsResponseContent'
        '400':
          description: Invalid input based on schemas.
          x-description-1: 'The PKCS #12 file is invalid. Please ensure the client certificate is not expired, the environment matches, and the key and certificate are not encrypted with a deprecated algorithm.'
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: put_apns
      x-release-lifecycle: GA
      x-operation-name: setApnsProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/push-notification/providers/fcm:
    patch:
      summary: Updates FCM Configuration
      description: Modify configuration details of the multi-factor authentication FCM provider associated with your tenant.
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationFcmRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationFcmRequestContent'
      responses:
        '200':
          description: FCM configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationFcmResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: patch_fcm
      x-release-lifecycle: GA
      x-operation-name: updateFcmProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
    put:
      summary: Overwrite FCM Configuration
      description: Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationFcmRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationFcmRequestContent'
      responses:
        '200':
          description: FCM configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationFcmResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: put_fcm
      x-release-lifecycle: GA
      x-operation-name: setFcmProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/push-notification/providers/fcmv1:
    patch:
      summary: Updates FCMV1 Configuration
      description: Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent'
      responses:
        '200':
          description: FCMV1 configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent'
        '400':
          description: Invalid input based on schemas
          x-description-1: Invalid server credentials
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: patch_fcmv1
      x-release-lifecycle: GA
      x-operation-name: updateFcmv1Provider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
    put:
      summary: Overwrite FCMV1 Configuration
      description: Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationFcmv1RequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationFcmv1RequestContent'
      responses:
        '200':
          description: FCMV1 configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent'
        '400':
          description: Invalid input based on schemas
          x-description-1: Invalid server credentials
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: put_fcmv1
      x-release-lifecycle: GA
      x-operation-name: setFcmv1Provider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/push-notification/providers/sns:
    get:
      summary: Get AWS SNS Configuration
      description: '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>. '
      tags:
      - guardian
      responses:
        '200':
          description: AWS SNS configuration successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorsProviderSnsResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_sns
      x-release-lifecycle: GA
      x-operation-name: getSnsProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    patch:
      summary: Update AWS SNS Configuration
      description: Configure the <a href="https://auth0.com/docs/multifactor-authentication/developer/sns-configuration">AWS SNS push notification provider configuration</a> (subscription required).
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationSnsRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationSnsRequestContent'
      responses:
        '200':
          description: AWS SNS configuration successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGuardianFactorsProviderPushNotificationSnsResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: patch_sns
      x-release-lifecycle: GA
      x-operation-name: updateSnsProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
    put:
      summary: Configure AWS SNS Configuration
      description: Configure the <a href="https://auth0.com/docs/multifactor-authentication/developer/sns-configuration">AWS SNS push notification provider configuration</a> (subscription required).
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationSnsRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationSnsRequestContent'
      responses:
        '200':
          description: AWS SNS configuration successfully updated.
          conte

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/openapi/auth0-guardian-api-openapi.yml