---
title: "Test a MFA Provider connection."
slug: "test-a-mfa-provider-connection-1"
updated: 2026-03-02T22:30:52Z
published: 2026-03-02T22:35:52Z
canonical: "support.appgate.com/test-a-mfa-provider-connection-1"
---

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

# Test a MFA Provider connection.

Post/mfa-providers/test

Test connection for the given MFA Provider JSON.

SecurityHTTPType bearer

Body parameters

MFA Provider object.

<select class='api-response-data' aria-label='Media type'><option value='7265e9b9-1fc1-471b-96ef-8ac669fee79d'>application/json</option>
</select>object  idstring  (uuid)    

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
namestring    Required

Name of the object.

Exampleobject
notesstring    

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.

tags Array of string   

Array of tags.

Example[
  "developer",
  "api-created"
]string    
typestring    Required

The type of the MFA Provider. "DefaultTimeBased" and "Fido2" are built-in, new ones cannot be created.

Valid values[
  "Radius",
  "DefaultTimeBased",
  "Fido2"
]
hostnames Array of string   

Hostnames/IP addresses to connect.

string    Examplemfa.company.com
portnumber    

Port to connect.

Example1812.0
inputTypestring    

The input type used in the client to enter the MFA code.

- "Masked" - The input is masked the same way as a password field.
- "Numeric" - The input is marked as a numeric input.
- "Text" - The input is handled as a regular plain text field.

Valid values[
  "Masked",
  "Numeric",
  "Text"
]Default"Masked"ExampleNumber
sharedSecretstring    

Radius shared secret to authenticate to the server.

authenticationProtocolstring    

Radius protocol to use while authenticating users.

Valid values[
  "PAP",
  "CHAP"
]Default"CHAP"
timeoutnumber    

Timeout in seconds before giving up on response.

Default6.0
modestring    

Defines the multi-factor authentication flow for RADIUS.

- "OneFactor" - The input from the user is sent as password and the response is used for result.
- "Challenge" - Before prompting the user, Controller sends a challenge request to the RADIUS server
using "challengeSharedSecret" or the user password. Data from the response is used with user input to
send the second RADIUS authentication request.
- "Push" - "challengeSharedSecret" or the user password is sent to RADIUS which triggers an external
authentication flow. When the external authentication flow returns success, the MFA attempt is
authenticated.

Valid values[
  "OneFactor",
  "Challenge",
  "Push"
]Default"Challenge"
useUserPasswordboolean    

-> If enabled, the Client will send the cached password instead of using challengeSharedSecret" to initiate the multi-factor authentication.

challengeSharedSecretstring  (password)    

-> Password sent to RADIUS to initiate multi-factor authentication. Required if "useUserPassword" is not enabled.

Responses200

Test result.

<select class='api-response-data' aria-label='Media type'><option value='ab8778c5-9d86-4831-af0e-a53253349a0a'>application/json</option>
</select>object  successboolean    

Whether the connection succeeded or not.

Examplefalse
errorboolean    

The error text if the connection fails.

ExampleConnection timed out.

400

JSON error. Check the JSON format.

<select class='api-response-data' aria-label='Media type'><option value='a6d24a87-a306-426c-8270-f49d222ba102'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

401

Token error. Login again.

<select class='api-response-data' aria-label='Media type'><option value='886e2719-cfd0-4091-9d4d-e56a8846ea3a'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

403

Insufficient permissions to access this resource.

<select class='api-response-data' aria-label='Media type'><option value='6a0debfc-0cef-4e22-b5a7-ecea43a53d04'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

406

Invalid 'Accept' header.

<select class='api-response-data' aria-label='Media type'><option value='3c9a3146-2278-4e79-87f8-0fb135f6cdcc'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

422

Request validation error. Check "errors" array for details.

<select class='api-response-data' aria-label='Media type'><option value='b8549703-477d-4bbd-8267-d72136f791e1'>application/json</option>
</select>Expand Allobject  

Http 422 error for object validation.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

errors Array of object   

List of fields with validation errors.

object  fieldstring    

Name of the field that failed validation.

Examplename
messagestring    

Failure reason.

Examplemay not be null