> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Get MFA Status

> Use this endpoint to retrieve the current MFA configuration and status for a user.



## OpenAPI

````yaml /en/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/mfa
openapi: 3.1.0
info:
  title: Identity Plugin
  description: ''
  version: 2.4.4
servers:
  - url: https://identity.sandbox.lerian.net
security: []
tags:
  - name: Groups API
  - name: Applications API
  - name: Users API
  - name: MFA API
  - name: Providers API
  - name: Application Providers API
paths:
  /v1/users/{id}/mfa:
    get:
      tags:
        - MFA API
      summary: Get MFA Status
      description: >-
        Use this endpoint to retrieve the current MFA configuration and status
        for a user.
      parameters:
        - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: MFA status and configuration for the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MFAStatusResponse'
              example:
                enabled: true
                preferredType: app
                methods:
                  - app
                totpEnabled: true
                emailEnabled: false
                smsEnabled: false
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error0003:
                  $ref: '#/components/examples/Error0003'
                Error0007:
                  $ref: '#/components/examples/Error0007'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error1003:
                  $ref: '#/components/examples/Error1003'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error0006:
                  $ref: '#/components/examples/Error0006'
          headers: {}
      security:
        - bearer: []
components:
  parameters:
    UserId:
      name: id
      in: path
      description: The unique identifier of the user you want to retrieve.
      required: true
      example: 019c96a0-0c21-71f9-a487-66a1258278a1
      schema:
        type: string
  schemas:
    MFAStatusResponse:
      description: The current MFA configuration and status for a user.
      type: object
      properties:
        enabled:
          type: boolean
          description: Indicates whether MFA is enabled for the user.
        preferredType:
          type: string
          description: The user's preferred MFA method.
          enum:
            - app
            - email
            - sms
        methods:
          type: array
          items:
            type: string
          description: List of MFA methods currently enabled for the user.
        totpEnabled:
          type: boolean
          description: Indicates whether app-based TOTP MFA is enabled.
        emailEnabled:
          type: boolean
          description: Indicates whether email-based MFA is enabled.
        smsEnabled:
          type: boolean
          description: Indicates whether SMS-based MFA is enabled.
    ErrorMessage:
      description: The response message error.
      type: object
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
  examples:
    Error0003:
      summary: Invalid Path Parameter
      value:
        code: IDE-0003
        title: Invalid Path Parameter
        message: One or more path parameters are in an incorrect format.
    Error0007:
      summary: Bad Request
      value:
        code: IDE-0007
        title: Bad Request
        message: The server could not understand the request due to malformed syntax.
    Error1003:
      summary: User ID Not Found
      value:
        code: IDE-1003
        title: User ID Not Found
        message: The provided user ID does not exist in our records.
    Error0006:
      summary: Internal Server Error
      value:
        code: IDE-0006
        title: Internal Server Error
        message: The server encountered an unexpected error. Please try again later.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: The authorization token in the 'Bearer <token>' format.

````