Frontegg MFA Configuration API

openapi: 3.0.0
info:
  title: Multi-Apps Overview Account Invitations MFA Configuration API
  description: Frontegg’s Multi-Apps feature simplifies and streamlines application management, delivering a seamless user experience. This section includes all necessary endpoints for managing applications and copying application settings across environments. All endpoints are categorized as **Management Endpoints**, requiring environment-level authorization and providing full control over entitlement resources.
  version: '1.0'
  x-metadata:
    note: Trigger publish artifacts job, remove this x-metadata after publishing
servers:
- url: https://api.frontegg.com/applications
  description: EU Region
- url: https://api.us.frontegg.com/applications
  description: US Region
- url: https://api.ca.frontegg.com/applications
  description: CA Region
- url: https://api.au.frontegg.com/applications
  description: AU Region
- url: https://{domain}.frontegg.com/applications
  description: Frontegg sub-domain for use with user tokens
  variables:
    domain:
      default: app-xxx
tags:
- name: MFA Configuration
  x-displayName: MFA configuration
paths:
  /resources/configurations/v1/mfa:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: MfaController_upsertMfaConfig
      summary: Update MFA Configuration
      description: 'Update the MFA configuration for your environment.


        Provide the desired configuration values as objects in the request body. Refer to the parameter documentation for the list of supported values.'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MfaConfigRequest'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MfaConfigResponse'
      tags:
      - MFA Configuration
      security:
      - bearer: []
    get:
      operationId: MfaController_getMfaConfig
      summary: Get MFA Configuration
      description: Retrieve the MFA configuration for your environment.
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MfaConfigResponse'
      tags:
      - MFA Configuration
      security:
      - bearer: []
components:
  schemas:
    MfaConfigRequest:
      type: object
      properties:
        authenticationApp:
          $ref: '#/components/schemas/MfaAuthAppConfig'
        sms:
          $ref: '#/components/schemas/MfaSmsConfig'
        email:
          $ref: '#/components/schemas/MfaEmailConfig'
    MfaConfigResponse:
      type: object
      properties:
        authenticationApp:
          $ref: '#/components/schemas/AuthenticationAppConfiguration'
        sms:
          $ref: '#/components/schemas/SmsConfiguration'
        email:
          $ref: '#/components/schemas/EmailConfiguration'
      required:
      - authenticationApp
      - sms
      - email
    MfaSmsConfig:
      type: object
      properties:
        active:
          type: boolean
        tokenLifetimeSeconds:
          type: number
          minimum: 300
      required:
      - active
      - tokenLifetimeSeconds
    MfaAuthAppConfig:
      type: object
      properties:
        active:
          type: boolean
        serviceName:
          type: string
      required:
      - active
      - serviceName
    EmailConfiguration:
      type: object
      properties:
        active:
          type: boolean
        tokenLifetimeSeconds:
          type: number
        sender:
          type: string
      required:
      - active
      - tokenLifetimeSeconds
      - sender
    MfaEmailConfig:
      type: object
      properties:
        active:
          type: boolean
        tokenLifetimeSeconds:
          type: number
          minimum: 300
        sender:
          type: string
      required:
      - active
      - tokenLifetimeSeconds
      - sender
    AuthenticationAppConfiguration:
      type: object
      properties:
        active:
          type: boolean
        serviceName:
          type: string
      required:
      - active
      - serviceName
    SmsConfiguration:
      type: object
      properties:
        active:
          type: boolean
        tokenLifetimeSeconds:
          type: number
      required:
      - active
      - tokenLifetimeSeconds
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
x-tagGroups:
- name: Management
  tags:
  - Applications settings