Email OTP
Create a new Email OTP MFA.
Create MFA of type Email OTP
The name of the target Multi Factor Authentication. This must be the actual Multi Factor Authentication name used in the RAS farm.
Site ID in which to modify the specified Multi Factor Authentication. If the parameter is omitted, the site ID of the Licensing Server will be used.
A user-defined Multi Factor Authentication description.
Enable or disable the Multi Factor Authentication upon creation. If the parameter is omitted, the Multi Factor Authentication is initialised as Disabled.
RADIUS type name.
User Enrollment
Show information for unenrolled users
Allow User Enrollment until date/time
The lifespan of the OTP (seconds)
External email storage
The content of the email. Possible variables: %OTP%, %DURATION%
The subject of the email. Possible variables: %OTP%
User message prompt
AD Custom Attribute
Allow enrollment of external email
The length of the OTP generated
Created
MFA Email OTP Settings
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Name
Site ID
Description
Whether MFA provider is enabled or not.
Provider Type
If true default criteria restriction settings will be inherited.
Display name
User Enrollment
Show information for unenrolled users
Allow User Enrollment until date/time
The lifespan of the OTP (seconds)
External email storage
The content of the email. Possible variables: %OTP%, %DURATION%
The subject of the email. Possible variables: %OTP%
User message prompt
AD Custom Attribute
Allow enrollment of external email
The length of the OTP generated
Unauthorized
Conflict
POST /api/MFA/EmailOTP HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 516
{
"name": "text",
"siteId": 1,
"description": "text",
"enabled": true,
"displayName": "text",
"userEnrollment": [
"0 = Allow",
"1 = AllowUntil",
"2 = DoNotAllow"
],
"showInformationForUnenrolledUsers": [
"0 = Always",
"1 = IfEnrollmentIsAllowed",
"2 = Never"
],
"untilDateTime": "2026-01-01T00:00:00.000Z",
"otpLifespanSec": 1,
"externalEmailStorage": [
"0 = RASDatabase",
"1 = ADMail",
"2 = ADCustom"
],
"emailContent": "text",
"emailSubject": "text",
"userMessagePrompt": "text",
"adCustomAttribute": "text",
"allowEnrollExternalEmail": true,
"otpLength": 1
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2026-01-01T00:00:00.000Z",
"timeLastMod": "2026-01-01T00:00:00.000Z",
"name": "text",
"siteId": 1,
"description": "text",
"enabled": true,
"type": [
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"inheritDefaultCriteriaSettings": true,
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"access": [
"0 = DenyCriteriaWhen",
"1 = AllowCriteriaWhen"
],
"devices": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"client": "text"
}
]
}
},
"displayName": "text",
"userEnrollment": [
"0 = Allow",
"1 = AllowUntil",
"2 = DoNotAllow"
],
"showInformationForUnenrolledUsers": [
"0 = Always",
"1 = IfEnrollmentIsAllowed",
"2 = Never"
],
"untilDateTime": "2026-01-01T00:00:00.000Z",
"otpLifespanSec": 1,
"externalEmailStorage": [
"0 = RASDatabase",
"1 = ADMail",
"2 = ADCustom"
],
"emailContent": "text",
"emailSubject": "text",
"userMessagePrompt": "text",
"adCustomAttribute": "text",
"allowEnrollExternalEmail": true,
"otpLength": 1
}Update the Email OTP MFA Site Settings.
The ID for which to modify the MFA settings.
Update MFA of type TOTP
The new name of the target multi-factor authentication .
A user-defined multi-factor authentication description.
Enable or disable the specified multi-factor authentication in a site.
If true default criteria settings will be inherited.
No Content
No content
Unauthorized
Not Found
PUT /api/MFA/EmailOTP/{id} HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 89
{
"name": "text",
"description": "text",
"enabled": true,
"inheritDefaultCriteriaSettings": true
}No content