{ "opencollection": "1.0.0", "info": { "name": "Multi-Apps Overview Account Invitations MFA API", "version": "1.0" }, "items": [ { "info": { "name": "MFA", "type": "folder" }, "items": [ { "info": { "name": "Recover MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/recover", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Recover multi-factor authentication (MFA) for a non-logged-in user.\n\nThis endpoint verifies a user's identity using a backup recovery code, typically generated by the user's MFA authenticator app during initial setup.\n\nUse this when a user cannot access their MFA device and needs to authenticate with their recovery code." }, { "info": { "name": "Disable Authenticator App MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/disable", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Disable MFA enrollment for a logged-in user within a specific account (tenant).\n\nThis endpoint disables multi-factor authentication for a user, using the `mfaToken` obtained from the user's authenticator app.\n\nUse this endpoint to programmatically disable MFA when managing authentication settings at the account (tenant) level." }, { "info": { "name": "Disable Authenticator App MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/authenticator/:deviceId/disable/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Disable multi-factor authentication (MFA) enrollment for a logged-in user within a specific account (tenant).\n\nThis endpoint removes MFA for a user, typically used in administrative contexts where a backend system or admin manages user security settings.\n\nThe request must include the `mfaToken`, which is the time-based one-time password (TOTP) generated by the user's authenticator app.\n\nUse this endpoint to programmatically disable MFA for a specific user within an account (tenant)." }, { "info": { "name": "Pre-disable SMS MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/sms/:deviceId/disable", "headers": [ { "name": "frontegg-user-id", "value": "" }, { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Initiate the process of disabling SMS-based multi-factor authentication (MFA) for a specific device.\n\nProvide the target `deviceId` in the request path to mark the SMS MFA device for pre-disablement. This action prepares the device for subsequent steps required to complete the removal.\n\nUse this route as part of the MFA management flow for disabling SMS-based MFA on a per-device basis." }, { "info": { "name": "Disable SMS MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/sms/:deviceId/disable/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Complete the process of disabling SMS-based multi-factor authentication (MFA) for a specific device.\n\nThis step finalizes MFA deactivation for the given `deviceId` after a prior pre-disable action.\n\nThe request must include:\n- `otcToken`: The one-time challenge token obtained during the pre-disable step.\n- `code`: The SMS verification code received by the user.\n\nUse this endpoint as the second step in the SMS MFA removal flow to verify the user's identity and confirm the disable action." }, { "info": { "name": "Verify MFA Using Code From Authenticator App", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/verify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify a multi-factor authentication (MFA) code generated by an authenticator app during the authentication process.\n\nThis endpoint completes the MFA step by validating the provided code.\n\nThe request must include:\n- `value`: The MFA service name (e.g., `authenticator`), as configured in your Authentication Settings.\n- `mfaToken`: The time-based one-time password (TOTP) generated by the user's authenticator app.\n\nUse this endpoint to verify the user's MFA code during an authentication challenge," }, { "info": { "name": "Request Verify MFA Using Email Code", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/emailcode", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify multi-factor authentication (MFA) using a code sent to the user's email.\n\nThis endpoint completes the email-based MFA verification step.\n\nThe request must include:\n- `mfaToken`: The token provided after the user initiates MFA via email.\n\nUse this endpoint to confirm the email-based MFA challenge and finalize the login or authentication process." }, { "info": { "name": "Verify MFA Using Email Code", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/emailcode/verify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify a multi-factor authentication (MFA) challenge using a code sent to the user's email address.\n\nThis endpoint finalizes the email-based MFA verification and completes the authentication process.\n\nThe request must include:\n- `otcToken`: One-time challenge token received during the email MFA initiation.\n- `code`: The MFA code sent to the user's email.\n- `mfaToken`: Token returned from the original MFA setup or step-up authentication request.\n- `rememberDevice` (optional): If set to `true`, th" }, { "info": { "name": "Pre Enroll MFA Using Authenticator App", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/authenticator/enroll", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Initiate enrollment in multi-factor authentication (MFA) using an authenticator app (e.g., Google Authenticator, Authy).\n\nThis endpoint begins the MFA setup process and returns the necessary data for configuring an authenticator app, such as a QR code or secret key.\n\nThe request must include:\n- `mfaToken`: A token received from the initial authentication flow that authorizes the MFA setup.\n\nUse this endpoint to generate the configuration required for linking an authenticator app before completin" }, { "info": { "name": "Enroll MFA Using Authenticator App", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/authenticator/enroll/verify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Complete enrollment in multi-factor authentication (MFA) using an authenticator app.\n\nThis endpoint verifies the MFA setup by validating the time-based one-time password (TOTP) generated by the authenticator app.\n\nThe request must include:\n- `token`: The 6-digit TOTP code generated by the authenticator app.\n- `mfaToken`: Token from the initial MFA enrollment initiation.\n- `rememberDevice` (optional): If set to `true`, the device will be remembered and may skip MFA on future logins from the same " }, { "info": { "name": "Verify MFA Using Authenticator App", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/authenticator/:deviceId/verify", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify multi-factor authentication (MFA) during the authentication process.\n\nThis endpoint is typically used after a primary login attempt when MFA is enabled for the user or account (tenant).\n\nThe request must include:\n- `value`: The MFA service name (e.g., `authenticator`, `email`, `sms`) configured under Authentication Settings.\n- `mfaToken`: The token or code provided by the user's MFA method (e.g., code from an authenticator app).\n\nUse this endpoint to complete the MFA verification step as " }, { "info": { "name": "Pre-enroll MFA Using Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/sms/enroll", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Initiate multi-factor authentication (MFA) enrollment using SMS.\n\nThis endpoint begins the SMS-based MFA setup by sending a verification code to the provided phone number.\n\nThe request must include:\n- `phoneNumber`: The user's mobile phone number in international format. It must match the format defined in your organization's phone number validation pattern (`phoneNumberRegexp`).\n\nUse this endpoint as the first step in enabling SMS-based MFA for a user." }, { "info": { "name": "Enroll MFA Using Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/sms/enroll/verify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Complete enrollment in multi-factor authentication (MFA) using SMS.\n\nThis endpoint finalizes the SMS-based MFA setup for the user by verifying the code sent to their phone number.\n\nThe request must include:\n- `otcToken`: Token received from the initial SMS MFA enrollment step.\n- `code`: The numeric code sent via SMS to the user's registered phone number.\n\nUse this endpoint to verify the user's phone number and activate SMS-based MFA on their account." }, { "info": { "name": "Request to Verify MFA Using Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/sms/:deviceId", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify multi-factor authentication (MFA) using an SMS-based device.\n\nThis endpoint confirms the SMS MFA challenge as part of the authentication or step-up verification process for a specific registered device.\n\nPath parameters:\n- `deviceId`: The unique identifier of the SMS MFA device being verified.\n\nRequest body must include:\n- `mfaToken`: Token provided during the authentication or challenge flow.\n\nUse this endpoint to complete SMS-based MFA verification for the specified device." }, { "info": { "name": "Verify MFA Using Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/sms/:deviceId/verify", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify a multi-factor authentication (MFA) challenge using an SMS code for a specific registered device.\n\nThis endpoint finalizes the MFA step by validating the SMS code and may mark the device as trusted if specified.\n\nPath parameters:\n- `deviceId`: The unique identifier of the SMS MFA device being verified.\n\nRequest body must include:\n- `otcToken`: Token received from the SMS MFA challenge initiation.\n- `code`: The verification code sent to the user's phone via SMS.\n- `mfaToken`: MFA token iss" }, { "info": { "name": "Pre Enroll MFA Using WebAuthN", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/webauthn/enroll", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Initiate multi-factor authentication (MFA) enrollment using WebAuthn (e.g., security keys, biometrics).\n\nThis endpoint begins the WebAuthn MFA setup by returning a browser-based challenge needed to link a trusted device, such as a biometric reader or hardware security key.\n\nThe request must include:\n- `mfaToken`: Token issued during the authentication flow to authorize MFA setup.\n\nUse this endpoint as the first step when enrolling a user in WebAuthn-based MFA." }, { "info": { "name": "Enroll MFA Using WebAuthN", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/webauthn/enroll/verify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Complete enrollment in multi-factor authentication (MFA) using WebAuthn.\n\nThis endpoint verifies and registers a WebAuthn device, such as a biometric sensor (Platform) or hardware security key (CrossPlatform), finalizing the setup after the initial challenge.\n\nThe request must include:\n- `deviceType`: Type of device being enrolled. Accepts `Platform` (e.g., fingerprint scanner) or `CrossPlatform` (e.g., USB security key).\n- `webauthnToken`: Token received during the WebAuthn pre-enrollment step." }, { "info": { "name": "Request Verify MFA Using WebAuthN", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/webauthn/:deviceId", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify a multi-factor authentication (MFA) challenge using a registered WebAuthn device.\n\nThis endpoint completes WebAuthn-based MFA verification, typically following primary authentication when WebAuthn is required as a second factor.\n\nPath parameters:\n- `deviceId`: The unique identifier of the WebAuthn device to be verified.\n\nRequest body must include:\n- `mfaToken`: Token issued during the login or step-up authentication flow.\n\nUse this endpoint to validate a WebAuthn device and complete the M" }, { "info": { "name": "Verify MFA Using Webauthn", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/auth/v1/user/mfa/webauthn/:deviceId/verify", "params": [ { "name": "deviceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify a multi-factor authentication (MFA) challenge using a WebAuthn device.\n\nThis endpoint completes MFA verification using a previously registered WebAuthn device such as a biometric sensor or hardware security key.\n\nPath parameters:\n- `deviceId`: The unique identifier of the registered WebAuthn device to be verified.\n\nRequest body must include:\n- `webauthnToken`: Token received from the server to initiate the WebAuthn challenge.\n- `options`: WebAuthn authentication response returned by the b" }, { "info": { "name": "Check if Remember Device Allowed", "type": "http" }, "http": { "method": "GET", "url": "https://api.frontegg.com/applications/resources/configurations/v1/mfa-policy/allow-remember-device", "headers": [ { "name": "frontegg-tenant-id", "value": "" } ], "params": [ { "name": "mfaToken", "value": "", "type": "query", "description": "MFA token from the response body of the first factor authentication" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Check whether the 'remember device' feature is allowed for MFA verification.\n\nThis endpoint returns whether device remembering is enabled globally or for a specific account (tenant), based on the request context.\n\nQuery parameters:\n- `mfaToken`: Token generated from the authenticator app or MFA challenge step.\n\nUse this endpoint to determine whether the user should be prompted with the option to remember their device during MFA verification." }, { "info": { "name": "Enroll Authenticator App MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/enroll", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Enroll a logged-in user in multi-factor authentication (MFA) for a specific account (tenant).\n\nThis endpoint initiates MFA enrollment on behalf of a user within a specific account (tenant) context.\n\nUse this route to programmatically trigger MFA enrollment, typically as part of an administrative or backend workflow." }, { "info": { "name": "Enroll Authenticator App MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/authenticator/enroll", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Enroll a logged-in user in multi-factor authentication (MFA) for a specific account (tenant).\n\nThis endpoint initiates MFA enrollment on behalf of a user within a specific account (tenant) context.\n\nUse this route to programmatically trigger MFA enrollment, typically as part of an administrative or backend workflow." }, { "info": { "name": "Verify Authenticator App MFA Enrollment", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/enroll/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify multi-factor authentication (MFA) enrollment using a QR code for a specific user.\n\nThis endpoint completes MFA setup after the user scans a QR code with their authenticator app (e.g., Google Authenticator, Authy).\n\nRequest body must include:\n- `mfaToken`: The time-based one-time password (TOTP) generated by the user's authenticator app after scanning the QR code.\n\nUse this endpoint to confirm that the user has successfully linked their authenticator app and to activate MFA for their accou" }, { "info": { "name": "Verify Authenticator App MFA Enrollment", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/authenticator/enroll/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify multi-factor authentication (MFA) enrollment using a QR code for a specific user within an account (tenant).\n\nThis endpoint completes MFA enrollment after the user scans a QR code with an authenticator app (e.g., Google Authenticator, Authy).\n\nRequest body must include:\n- `mfaToken`: The time-based one-time password (TOTP) generated by the authenticator app after scanning the QR code.\n\nUse this endpoint to confirm that the user has successfully registered their authenticator app and to ac" }, { "info": { "name": "Enroll SMS MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/sms/enroll", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Enroll a user in SMS-based multi-factor authentication (MFA).\n\nThis endpoint initiates SMS MFA enrollment by sending a verification code to the user's phone number.\n\nRequest body must include:\n- `phoneNumber`: The user's mobile number in international format. Must match the validation pattern defined by `phoneNumberRegexp`.\n\nUse this endpoint to begin the SMS MFA setup process for a specific user. The next step is to verify the SMS code to complete enrollment." }, { "info": { "name": "Verify MFA Enrollment", "type": "http" }, "http": { "method": "POST", "url": "https://api.frontegg.com/applications/resources/users/v1/mfa/sms/enroll/verify", "headers": [ { "name": "frontegg-user-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Complete SMS-based multi-factor authentication (MFA) enrollment for a user.\n\nThis endpoint finalizes SMS MFA setup by verifying the code sent to the user's phone.\n\nRequest body must include:\n- `otcToken`: One-time challenge token received from the initial enrollment step.\n- `code`: The verification code sent to the user's phone via SMS.\n\nUse this endpoint to verify the user's phone number and activate SMS-based MFA for their account." } ] } ], "bundled": true }