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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationSnsResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: put_sns
      x-release-lifecycle: GA
      x-operation-name: setSnsProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/push-notification/selected-provider:
    get:
      summary: Get Push Notification Provider
      description: '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>. '
      tags:
      - guardian
      responses:
        '200':
          description: Returns selected push notification provider
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorsProviderPushNotificationResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: get_pn_providers
      x-release-lifecycle: GA
      x-operation-name: getSelectedProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    put:
      summary: Update Push Notification Configuration
      description: '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>. '
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationRequestContent'
      responses:
        '200':
          description: Returns selected push notification provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderPushNotificationResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: put_pn_providers
      x-release-lifecycle: GA
      x-operation-name: setProvider
      x-operation-group:
      - guardian
      - factors
      - pushNotification
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/sms/providers/twilio:
    get:
      summary: Get Twilio SMS Configuration
      description: "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."
      tags:
      - guardian
      responses:
        '200':
          description: Twilio SMS configuration successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorsProviderSmsTwilioResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_sms_twilio_factor_provider
      x-release-lifecycle: GA
      x-operation-name: getTwilioProvider
      x-operation-group:
      - guardian
      - factors
      - sms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    put:
      summary: Update Twilio SMS Configuration
      description: "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."
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderSmsTwilioRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderSmsTwilioRequestContent'
      responses:
        '200':
          description: Twilio SMS configuration successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderSmsTwilioResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: put_sms_twilio_factor_provider
      x-release-lifecycle: GA
      x-operation-name: setTwilioProvider
      x-operation-group:
      - guardian
      - factors
      - sms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/sms/selected-provider:
    get:
      summary: Get SMS Configuration
      description: "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."
      tags:
      - guardian
      responses:
        '200':
          description: Returns selected SMS provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorsProviderSmsResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: get_sms_providers
      x-release-lifecycle: GA
      x-operation-name: getSelectedProvider
      x-operation-group:
      - guardian
      - factors
      - sms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    put:
      summary: Update SMS Configuration
      description: "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."
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderSmsRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorsProviderSmsRequestContent'
      responses:
        '200':
          description: Returns selected SMS provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorsProviderSmsResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: put_sms_providers
      x-release-lifecycle: GA
      x-operation-name: setProvider
      x-operation-group:
      - guardian
      - factors
      - sms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/sms/templates:
    get:
      summary: Get SMS Enrollment and Verification Templates
      description: "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."
      tags:
      - guardian
      responses:
        '200':
          description: SMS enrollment and verification templates successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorSmsTemplatesResponseContent'
        '204':
          description: No content.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardianFactorSmsTemplatesResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: get_factor_sms_templates
      x-release-lifecycle: GA
      x-operation-name: getTemplates
      x-operation-group:
      - guardian
      - factors
      - sms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:guardian_factors
    put:
      summary: Update SMS Enrollment and Verification Templates
      description: "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."
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorSmsTemplatesRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorSmsTemplatesRequestContent'
      responses:
        '200':
          description: SMS enrollment and verification templates successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorSmsTemplatesResponseContent'
        '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_sms_templates
      x-release-lifecycle: GA
      x-operation-name: setTemplates
      x-operation-group:
      - guardian
      - factors
      - sms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/factors/{name}:
    put:
      summary: Update Multi-factor Authentication Type
      description: Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.
      tags:
      - guardian
      parameters:
      - name: name
        in: path
        description: Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`.
        required: true
        schema:
          $ref: '#/components/schemas/GuardianFactorNameEnum'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianFactorRequestContent'
      responses:
        '200':
          description: Factor updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianFactorResponseContent'
        '400':
          description: Invalid input based on schemas.
        '401':
          description: Token has expired or signature is invalid.
        '403':
          description: Insufficient scope.
      operationId: put_factors_by_name
      x-release-lifecycle: GA
      x-operation-name: set
      x-operation-group:
      - guardian
      - factors
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:guardian_factors
  /guardian/policies:
    get:
      summary: Get Multi-factor Authentication Policies
      description: 'Retrieve the <a href="https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa">multi-factor authentication (MFA) policies</a> configured for your tenant.


        The following policies are supported:

        <ul>

        <li><code>all-applications</code> policy prompts with MFA for all logins.</li>

        <li><code>confidence-score</code> policy prompts with MFA only for low confidence logins.</li>

        </ul>


        <b>Note</b>: The <code>confidence-score</code> policy is part of the <a href="https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa">Adaptive MFA feature</a>. Adaptive MFA requires an add-on for the Enterprise plan; review <a href="https://auth0.com/pricing">Auth0 Pricing</a> for more details.

        '
      tags:
      - guardian
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGuardianPoliciesResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: get_policies
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-group:
      - guardian
      - policies
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:mfa_policies
    put:
      summary: Update Multi-factor Authentication Policies
      description: 'Set <a href="https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa">multi-factor authentication (MFA) policies</a> for your tenant.


        The following policies are supported:

        <ul>

        <li><code>all-applications</code> policy prompts with MFA for all logins.</li>

        <li><code>confidence-score</code> policy prompts with MFA only for low confidence logins.</li>

        </ul>


        <b>Note</b>: The <code>confidence-score</code> policy is part of the <a href="https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa">Adaptive MFA feature</a>. Adaptive MFA requires an add-on for the Enterprise plan; review <a href="https://auth0.com/pricing">Auth0 Pricing</a> for more details.

        '
      tags:
      - guardian
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGuardianPoliciesRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SetGuardianPoliciesRequestContent'
      responses:
        '200':
          description: Policies updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetGuardianPoliciesResponseContent'
        '400':
          description: Invalid input based on schemas
        '401':
          description: Token has expired or signature is invalid
        '403':
          description: Insufficient scope
      operationId: put_policies
      x-release-lifecycle: GA
      x-operation-name: set
      x-operation-group:
      - guardian
      - policies
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:mfa_policies
components:
  schemas:
    SetGuardianFactorsProviderPhoneResponseContent:
      type: object
      additionalProperties: false
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderSmsProviderEnum'
    SetGuardianPoliciesRequestContent:
      type: array
      items:
        $ref: '#/components/schemas/MFAPolicyEnum'
    GetGuardianFactorsProviderPhoneResponseContent:
      type: object
      additionalProperties: false
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderSmsProviderEnum'
    SetGuardianFactorResponseContent:
      type: object
      additionalProperties: false
      required:
      - enabled
      properties:
        enabled:
          type: boolean
          description: Whether this factor is enabled (true) or disabled (false).
    GetGuardianFactorsProviderSmsTwilioResponseContent:
      type: object
      additionalProperties: false
      properties:
        from:
          type:
          - string
          - 'null'
          description: From number
          default: '+1223323'
          minLength: 0
          maxLength: 64
        messaging_service_sid:
          type:
          - string
          - 'null'
          description: Copilot SID
          default: 5dEkAiHLPCuQ1uJj4qNXcAnERFAL6cpq
          minLength: 1
          maxLength: 1000
        auth_token:
          type:
          - string
          - 'null'
          description: Twilio Authentication token
          default: zw5Ku6z2sxhd0ZVXto5SDHX6KPDByJPU
          minLength: 1
          maxLength: 1000
        sid:
          type:
          - string
          - 'null'
          description: Twilio SID
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
    GuardianFactorNameEnum:
      type: string
      description: Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`.
      default: sms
      minLength: 1
      enum:
      - push-notification
      - sms
      - email
      - duo
      - otp
      - webauthn-roaming
      - webauthn-platform
      - recovery-code
    SetGuardianFactorsProviderPushNotificationFcmv1RequestContent:
      type: object
      additionalProperties: false
      properties:
        server_credentials:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 10000
    CreateGuardianEnrollmentTicketResponseContent:
      type: object
      additionalProperties: true
      properties:
        ticket_id:
          type: string
          description: The ticket_id used to identify the enrollment
          default: u2x2-u2x2-u2x2-u2x2-u2x2-u2x2
        ticket_url:
          type: string
          description: The url you can use to start enrollment
          format: url
    SetGuardianFactorsProviderPhoneTwilioResponseContent:
      type: object
      additionalProperties: false
      properties:
        from:
          type:
          - string
          - 'null'
          description: From number
          default: '+1223323'
          minLength: 0
          maxLength: 64
        messaging_service_sid:
          type:
          - string
          - 'null'
          description: Copilot SID
          default: 5dEkAiHLPCuQ1uJj4qNXcAnERFAL6cpq
          minLength: 1
          maxLength: 1000
        auth_token:
          type:
          - string
          - 'null'
          description: Twilio Authentication token
          default: zw5Ku6z2sxhd0ZVXto5SDHX6KPDByJPU
          minLength: 1
          maxLength: 1000
        sid:
          type:
          - string
          - 'null'
          description: Twilio SID
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
    UpdateGuardianFactorsProviderPushNotificationFcmRequestContent:
      type: object
      additionalProperties: false
      properties:
        server_key:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 152
    GetGuardianFactorsProviderApnsResponseContent:
      type: object
      additionalProperties: false
      properties:
        bundle_id:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 20
        sandbox:
          type: boolean
        enabled:
          type: boolean
    MFAPolicyEnum:
      type: string
      description: The MFA policy
      enum:
      - all-applications
      - confidence-score
    SetGuardianFactorsProviderPushNotificationFcmResponseContent:
      type: object
      additionalProperties: true
      minProperties: 0
      maxProperties: 0
    SetGuardianFactorPhoneMessageTypesRequestContent:
      type: object
      additionalProperties: false
      required:
      - message_types
      properties:
        message_types:
          type: array
          description: The list of phone factors to enable on the tenant. Can include `sms` and `voice`.
          items:
            $ref: '#/components/schemas/GuardianFactorPhoneFactorMessageTypeEnum'
    SetGuardianFactorPhoneTemplatesResponseContent:
      type: object
      additionalProperties: false
      required:
      - enrollment_message
      - verification_message
      properties:
        enrollment_message:
          type: string
          description: Message sent to the user when they are invited to enroll with a phone number.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.'
        verification_message:
          type: string
          description: Message sent to the user when they are prompted to verify their account.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}'
    SetGuardianFactorsProviderPushNotificationApnsResponseContent:
      type: object
      additionalProperties: false
      properties:
        sandbox:
          type: boolean
        bundle_id:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
    SetGuardianFactorsProviderSmsResponseContent:
      type: object
      additionalProperties: false
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderSmsProviderEnum'
    GuardianFactorsProviderSmsProviderEnum:
      type: string
      enum:
      - auth0
      - twilio
      - phone-message-hook
    SetGuardianFactorsProviderPushNotificationSnsRequestContent:
      type: object
      additionalProperties: false
      properties:
        aws_access_key_id:
          type:
          - string
          - 'null'
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
        aws_secret_access_key:
          type:
          - string
          - 'null'
          default: B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL
          minLength: 1
          maxLength: 1000
        aws_region:
          type:
          - string
          - 'null'
          default: us-west-1
          minLength: 1
          maxLength: 1000
          pattern: ^(?:us-east-[0-9]{1,2}|us-west-[0-9]{1,2}|ap-southeast-[0-9]{1,2}|ap-northeast-[0-9]{1,2}|ap-central-[0-9]{1,2}|eu-west-[0-9]{1,2}|eu-central-[0-9]{1,2})$
        sns_apns_platform_application_arn:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
        sns_gcm_platform_application_arn:
          type:
          - string
          - 'null'
          default: urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP
          minLength: 1
          maxLength: 1000
    SetGuardianFactorSmsTemplatesResponseContent:
      type: object
      additionalProperties: false
      required:
      - enrollment_message
      - verification_message
      properties:
        enrollment_message:
          type: string
          description: Message sent to the user when they are invited to enroll with a phone number.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.'
        verification_message:
          type: string
          description: Message sent to the user when they are prompted to verify their account.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}'
    UpdateGuardianFactorsProviderPushNotificationSnsResponseContent:
      type: object
      additionalProperties: false
      properties:
        aws_access_key_id:
          type:
          - string
          - 'null'
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
        aws_secret_access_key:
          type:
          - string
          - 'null'
          default: B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL
          minLength: 1
          maxLength: 1000
        aws_region:
          type:
          - string
          - 'null'
          default: us-west-1
          minLength: 1
          maxLength: 1000
          pattern: ^(?:us-east-[0-9]{1,2}|us-west-[0-9]{1,2}|ap-southeast-[0-9]{1,2}|ap-northeast-[0-9]{1,2}|ap-central-[0-9]{1,2}|eu-west-[0-9]{1,2}|eu-central-[0-9]{1,2})$
        sns_apns_platform_application_arn:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
        sns_gcm_platform_application_arn:
          type:
          - string
          - 'null'
          default: urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP
          minLength: 1
          maxLength: 1000
    SetGuardianFactorsProviderSmsRequestContent:
      type: object
      additionalProperties: false
      required:
      - provider
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderSmsProviderEnum'
    SetGuardianPoliciesResponseContent:
      type: array
      items:
        $ref: '#/components/schemas/MFAPolicyEnum'
    GuardianFactor:
      type: object
      additionalProperties: false
      required:
      - enabled
      properties:
        enabled:
          type: boolean
          description: Whether this factor is enabled (true) or disabled (false).
          default: true
        trial_expired:
          type: boolean
          description: Whether trial limits have been exceeded.
          default: true
        name:
          $ref: '#/components/schemas/GuardianFactorNameEnum'
    UpdateGuardianFactorsProviderPushNotificationSnsRequestContent:
      type: object
      additionalProperties: false
      properties:
        aws_access_key_id:
          type:
          - string
          - 'null'
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
        aws_secret_access_key:
          type:
          - string
          - 'null'
          default: B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL
          minLength: 1
          maxLength: 1000
        aws_region:
          type:
          - string
          - 'null'
          default: us-west-1
          minLength: 1
          maxLength: 1000
          pattern: ^(?:us-east-[0-9]{1,2}|us-west-[0-9]{1,2}|ap-southeast-[0-9]{1,2}|ap-northeast-[0-9]{1,2}|ap-central-[0-9]{1,2}|eu-west-[0-9]{1,2}|eu-central-[0-9]{1,2})$
        sns_apns_platform_application_arn:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
        sns_gcm_platform_application_arn:
          type:
          - string
          - 'null'
          default: urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP
          minLength: 1
          maxLength: 1000
    GuardianFactorPhoneFactorMessageTypeEnum:
      type: string
      enum:
      - sms
      - voice
    UpdateGuardianFactorsProviderPushNotificationApnsResponseContent:
      type: object
      additionalProperties: false
      properties:
        sandbox:
          type: boolean
        bundle_id:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
    SetGuardianFactorsProviderPushNotificationFcmRequestContent:
      type: object
      additionalProperties: false
      properties:
        server_key:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 152
    UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent:
      type: object
      additionalProperties: true
      minProperties: 0
      maxProperties: 0
    SetGuardianFactorsProviderPushNotificationSnsResponseContent:
      type: object
      additionalProperties: false
      properties:
        aws_access_key_id:
          type:
          - string
          - 'null'
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
        aws_secret_access_key:
          type:
          - string
          - 'null'
          default: B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL
          minLength: 1
          maxLength: 1000
        aws_region:
          type:
          - string
          - 'null'
          default: us-west-1
          minLength: 1
          maxLength: 1000
          pattern: ^(?:us-east-[0-9]{1,2}|us-west-[0-9]{1,2}|ap-southeast-[0-9]{1,2}|ap-northeast-[0-9]{1,2}|ap-central-[0-9]{1,2}|eu-west-[0-9]{1,2}|eu-central-[0-9]{1,2})$
        sns_apns_platform_application_arn:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
        sns_gcm_platform_application_arn:
          type:
          - string
          - 'null'
          default: urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP
          minLength: 1
          maxLength: 1000
    UpdateGuardianFactorsProviderPushNotificationApnsRequestContent:
      type: object
      additionalProperties: false
      properties:
        sandbox:
          type: boolean
        bundle_id:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
        p12:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 10000
    GuardianEnrollmentFactorEnum:
      type: string
      description: 'Optional. Specifies which factor the user must enroll with.<br />Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom MFA pages.'
      enum:
      - push-notification
      - phone
      - email
      - otp
      - webauthn-roaming
      - webauthn-platform
    SetGuardianFactorsProviderSmsTwilioRequestContent:
      type: object
      additionalProperties: false
      properties:
        from:
          type:
          - string
          - 'null'
          description: From number
          default: '+1223323'
          minLength: 0
          maxLength: 64
        messaging_service_sid:
          type:
          - string
          - 'null'
          description: Copilot SID
          default: 5dEkAiHLPCuQ1uJj4qNXcAnERFAL6cpq
          minLength: 1
          maxLength: 1000
        auth_token:
          type:
          - string
          - 'null'
          description: Twilio Authentication token
          default: zw5Ku6z2sxhd0ZVXto5SDHX6KPDByJPU
          minLength: 1
          maxLength: 1000
        sid:
          type:
          - string
          - 'null'
          description: Twilio SID
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
    UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent:
      type: object
      additionalProperties: false
      properties:
        server_credentials:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 10000
    SetGuardianFactorDuoSettingsResponseContent:
      type: object
      additionalProperties: false
      properties:
        ikey:
          type: string
          maxLength: 10000
        skey:
          type: string
          maxLength: 10000
          format: non-empty-string
        host:
          type: string
          maxLength: 10000
    GetGuardianFactorsProviderPushNotificationResponseContent:
      type: object
      additionalProperties: false
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderPushNotificationProviderDataEnum'
    GuardianFactorsProviderPushNotificationProviderDataEnum:
      type: string
      enum:
      - guardian
      - sns
      - direct
    SetGuardianFactorPhoneMessageTypesResponseContent:
      type: object
      additionalProperties: false
      properties:
        message_types:
          type: array
          description: The list of phone factors to enable on the tenant. Can include `sms` and `voice`.
          items:
            $ref: '#/components/schemas/GuardianFactorPhoneFactorMessageTypeEnum'
    GetGuardianFactorsProviderSmsResponseContent:
      type: object
      additionalProperties: false
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderSmsProviderEnum'
    SetGuardianFactorRequestContent:
      type: object
      additionalProperties: false
      required:
      - enabled
      properties:
        enabled:
          type: boolean
          description: Whether this factor is enabled (true) or disabled (false).
    SetGuardianFactorDuoSettingsRequestContent:
      type: object
      additionalProperties: false
      properties:
        ikey:
          type: string
          maxLength: 10000
        skey:
          type: string
          maxLength: 10000
          format: non-empty-string
        host:
          type: string
          maxLength: 10000
    SetGuardianFactorsProviderPhoneTwilioRequestContent:
      type: object
      additionalProperties: false
      properties:
        from:
          type:
          - string
          - 'null'
          description: From number
          default: '+1223323'
          minLength: 0
          maxLength: 64
        messaging_service_sid:
          type:
          - string
          - 'null'
          description: Copilot SID
          default: 5dEkAiHLPCuQ1uJj4qNXcAnERFAL6cpq
          minLength: 1
          maxLength: 1000
        auth_token:
          type:
          - string
          - 'null'
          description: Twilio Authentication token
          default: zw5Ku6z2sxhd0ZVXto5SDHX6KPDByJPU
          minLength: 1
          maxLength: 1000
        sid:
          type:
          - string
          - 'null'
          description: Twilio SID
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
    GetGuardianFactorPhoneTemplatesResponseContent:
      type: object
      additionalProperties: false
      required:
      - enrollment_message
      - verification_message
      properties:
        enrollment_message:
          type: string
          description: Message sent to the user when they are invited to enroll with a phone number.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.'
        verification_message:
          type: string
          description: Message sent to the user when they are prompted to verify their account.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}'
    GetGuardianFactorSmsTemplatesResponseContent:
      type: object
      additionalProperties: false
      required:
      - enrollment_message
      - verification_message
      properties:
        enrollment_message:
          type: string
          description: Message sent to the user when they are invited to enroll with a phone number.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.'
        verification_message:
          type: string
          description: Message sent to the user when they are prompted to verify their account.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}'
    SetGuardianFactorsProviderPushNotificationRequestContent:
      type: object
      additionalProperties: false
      required:
      - provider
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderPushNotificationProviderDataEnum'
    UpdateGuardianFactorDuoSettingsRequestContent:
      type: object
      additionalProperties: false
      properties:
        ikey:
          type: string
          maxLength: 10000
        skey:
          type: string
          maxLength: 10000
          format: non-empty-string
        host:
          type: string
          maxLength: 10000
    SetGuardianFactorsProviderPushNotificationApnsRequestContent:
      type: object
      additionalProperties: false
      properties:
        sandbox:
          type: boolean
        bundle_id:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
        p12:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 10000
    UpdateGuardianFactorsProviderPushNotificationFcmResponseContent:
      type: object
      additionalProperties: true
      minProperties: 0
      maxProperties: 0
    GetGuardianEnrollmentResponseContent:
      type: object
      additionalProperties: false
      required:
      - id
      properties:
        id:
          type: string
          description: ID for this enrollment.
          default: dev_0000000000000001
        status:
          $ref: '#/components/schemas/GuardianEnrollmentStatus'
        name:
          type: string
          description: Device name (only for push notification).
          default: iPhone 7
          minLength: 1
          maxLength: 20
          pattern: ^\+[0-9]{8, 20}
        identifier:
          type: string
          description: Device identifier. This is usually the phone identifier.
          default: 76dc-a90c-a88c-a90c-a88c-a88c-a90c
        phone_number:
          type: string
          description: Phone number.
          default: +1 999999999999
        enrolled_at:
          $ref: '#/components/schemas/GuardianEnrollmentDate'
        last_auth:
          $ref: '#/components/schemas/GuardianEnrollmentDate'
    GetGuardianFactorDuoSettingsResponseContent:
      type: object
      additionalProperties: false
      properties:
        ikey:
          type: string
          maxLength: 10000
        skey:
          type: string
          maxLength: 10000
          format: non-empty-string
        host:
          type: string
          maxLength: 10000
    GetGuardianFactorPhoneMessageTypesResponseContent:
      type: object
      additionalProperties: false
      properties:
        message_types:
          type: array
          description: The list of phone factors to enable on the tenant. Can include `sms` and `voice`.
          items:
            $ref: '#/components/schemas/GuardianFactorPhoneFactorMessageTypeEnum'
    SetGuardianFactorsProviderPhoneRequestContent:
      type: object
      additionalProperties: false
      required:
      - provider
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderSmsProviderEnum'
    ListGuardianPoliciesResponseContent:
      type: array
      items:
        $ref: '#/components/schemas/MFAPolicyEnum'
    GuardianEnrollmentDate:
      type: string
      default: '2016-07-12T17:56:26.804Z'
      description: Enrollment date and time.
    SetGuardianFactorPhoneTemplatesRequestContent:
      type: object
      additionalProperties: false
      required:
      - enrollment_message
      - verification_message
      properties:
        enrollment_message:
          type: string
          description: Message sent to the user when they are invited to enroll with a phone number.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.'
        verification_message:
          type: string
          description: Message sent to the user when they are prompted to verify their account.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}'
    CreateGuardianEnrollmentTicketRequestContent:
      type: object
      additionalProperties: false
      required:
      - user_id
      properties:
        user_id:
          type: string
          description: user_id for the enrollment ticket
          format: user-id
        email:
          type: string
          description: alternate email to which the enrollment email will be sent. Optional - by default, the email will be sent to the user's default address
          format: email
        send_mail:
          type: boolean
          description: Send an email to the user to start the enrollment
        email_locale:
          type: string
          description: Optional. Specify the locale of the enrollment email. Used with send_email.
        factor:
          $ref: '#/components/schemas/GuardianEnrollmentFactorEnum'
        allow_multiple_enrollments:
          type: boolean
          description: 'Optional. Allows a user who has previously enrolled in MFA to enroll with additional factors.<br />Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom MFA pages.'
    GuardianEnrollmentStatus:
      type: string
      description: Status of this enrollment. Can be `pending` or `confirmed`.
      default: pending
      enum:
      - pending
      - confirmed
    GetGuardianFactorsProviderPhoneTwilioResponseContent:
      type: object
      additionalProperties: false
      properties:
        from:
          type:
          - string
          - 'null'
          description: From number
          default: '+1223323'
          minLength: 0
          maxLength: 64
        messaging_service_sid:
          type:
          - string
          - 'null'
          description: Copilot SID
          default: 5dEkAiHLPCuQ1uJj4qNXcAnERFAL6cpq
          minLength: 1
          maxLength: 1000
        auth_token:
          type:
          - string
          - 'null'
          description: Twilio Authentication token
          default: zw5Ku6z2sxhd0ZVXto5SDHX6KPDByJPU
          minLength: 1
          maxLength: 1000
        sid:
          type:
          - string
          - 'null'
          description: Twilio SID
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
    SetGuardianFactorsProviderPushNotificationResponseContent:
      type: object
      additionalProperties: false
      properties:
        provider:
          $ref: '#/components/schemas/GuardianFactorsProviderPushNotificationProviderDataEnum'
    UpdateGuardianFactorDuoSettingsResponseContent:
      type: object
      additionalProperties: false
      properties:
        ikey:
          type: string
          maxLength: 10000
        skey:
          type: string
          maxLength: 10000
          format: non-empty-string
        host:
          type: string
          maxLength: 10000
    SetGuardianFactorSmsTemplatesRequestContent:
      type: object
      additionalProperties: false
      required:
      - enrollment_message
      - verification_message
      properties:
        enrollment_message:
          type: string
          description: Message sent to the user when they are invited to enroll with a phone number.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.'
        verification_message:
          type: string
          description: Message sent to the user when they are prompted to verify their account.
          default: '{{code}} is your verification code for {{tenant.friendly_name}}'
    GetGuardianFactorsProviderSnsResponseContent:
      type: object
      additionalProperties: false
      properties:
        aws_access_key_id:
          type:
          - string
          - 'null'
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
        aws_secret_access_key:
          type:
          - string
          - 'null'
          default: B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL
          minLength: 1
          maxLength: 1000
        aws_region:
          type:
          - string
          - 'null'
          default: us-west-1
          minLength: 1
          maxLength: 1000
          pattern: ^(?:us-east-[0-9]{1,2}|us-west-[0-9]{1,2}|ap-southeast-[0-9]{1,2}|ap-northeast-[0-9]{1,2}|ap-central-[0-9]{1,2}|eu-west-[0-9]{1,2}|eu-central-[0-9]{1,2})$
        sns_apns_platform_application_arn:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1000
        sns_gcm_platform_application_arn:
          type:
          - string
          - 'null'
          default: urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP
          minLength: 1
          maxLength: 1000
    SetGuardianFactorsProviderSmsTwilioResponseContent:
      type: object
      additionalProperties: false
      properties:
        from:
          type:
          - string
          - 'null'
          description: From number
          default: '+1223323'
          minLength: 0
          maxLength: 64
        messaging_service_sid:
          type:
          - string
          - 'null'
          description: Copilot SID
          default: 5dEkAiHLPCuQ1uJj4qNXcAnERFAL6cpq
          minLength: 1
          maxLength: 1000
        auth_token:
          type:
          - string
          - 'null'
          description: Twilio Authentication token
          default: zw5Ku6z2sxhd0ZVXto5SDHX6KPDByJPU
          minLength: 1
          maxLength: 1000
        sid:
          type:
          - string
          - 'null'
          description: Twilio SID
          default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40
          minLength: 1
          maxLength: 1000
    SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent:
      type: object
      additionalProperties: true
      minProperties: 0
      maxProperties: 0