feat: add mfa recipe and info endpoint

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 
+## [1.19.0] - 2023-10-XX
+
+### Added
+
+- Added an endpoint to query information about MFA factors
+- Updated loginmethods (`{apiBasePath}/loginmethods`) response type to include a list of first factors
+
 ## [1.18.0] - 2023-08-XX
 
 ### Changed

api_spec.yaml

@@ -4,7 +4,7 @@ info:
   description: |
     These are the APIs exposed by our backend SDK. To be consumed by the frontend only.
     `<tenantId>` in all the APIs are optional. Its default value is `public`
-  version: "1.18.0"
+  version: "1.19.0"
   title: Frontend Driver Interface
   contact:
     email: [email protected]
@@ -16,10 +16,79 @@ tags:
   - name: Passwordless Recipe
   - name: ThirdPartyPasswordless Recipe
   - name: EmailVerification Recipe
+  - name: MultiFactorAuth Recipe
   - name: JWT Recipe
   - name: OpenId Recipe
 paths:
 
+
+  /{apiBasePath}/mfa/info:
+    get:
+      tags:
+        - MultiFactorAuth Recipe
+      operationId: getMFAInfo
+      description: |
+        Returns information about the auth factors of the current user and refreshes the related session claim
+      parameters:
+        - $ref: '#/components/parameters/apiBasePath'
+        - $ref: '#/components/parameters/multiFactorAuthRid'
+        - $ref: '#/components/parameters/anti-csrf'
+      security:
+        - AccessTokenBearer: []
+        - AccessTokenCookie: []
+
+      responses:
+        '200':
+          description: Information about the auth factors of the current user and optionally the session with a refreshed MFA claim
+          headers:
+            Set-Cookie:
+              description: Sent in cookie-based sessions if the access token payload is updated
+              schema:
+                type: string
+                example: 'sAccessToken=eyJhb...%3D%3D; Path=/; Expires=Tue, 22 Jun 2021 07:43:07 GMT; HttpOnly; SameSite=Lax'
+            st-access-token:
+              description: Sent in cookie-based sessions if the access token payload is updated
+              schema:
+                $ref: '#/components/schemas/token'
+            anti-csrf:
+              description: Sent if enabled by the user
+              schema:
+                $ref: '#/components/schemas/token'
+            front-token:
+              description: Sent if the access token payload is updated
+              schema:
+                $ref: '#/components/schemas/token'
+            Access-Control-Expose-Headers:
+              schema:
+                type: string
+                example: 'anti-csrf, front-token, st-access-token'
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - type: object
+                    properties:
+                      status:
+                        $ref: '#/components/schemas/statusOK'
+                      info:
+                        type: object
+                        properties:
+                          isAlreadySetup:
+                            type: array
+                            items:
+                              type: string
+                          isAllowedToSetup:
+                            type: array
+                            items:
+                              type: string
+                  - $ref: '#/components/schemas/generalErrorResponse'
+
+        '404':
+          $ref: '#/components/responses/404'
+
+        '500':
+          $ref: '#/components/responses/500'
+
   /{apiBasePath}/<tenantId>/signinup/code⠀:
     post:
       tags:
@@ -1347,6 +1416,10 @@ paths:
                               enabled:
                                 type: boolean
                                 example: true
+                          firstFactors:
+                            type: array
+                            items:
+                              type: string
                   - $ref: '#/components/schemas/generalErrorResponse'
         '404':
           $ref: '#/components/responses/404'        
@@ -2130,6 +2203,13 @@ components:
       example: multitenancy
       schema:
         type: string
+
+    multiFactorAuthRid:
+      name: rid
+      in: header
+      example: multifactorauth
+      schema:
+        type: string
 
     anti-csrf:
       name: anti-csrf