Multi-factor authentication settings
Work in progress! This API is a work in progress and may change in future releases. In this version, allowing MFA to a user automatically enables it for them.
API actions
API path: panel/user/mfa/settings.
required permissions: users: "update".
Set the multi-factor authentication policy for specific users, or for all of them.
Both target and settings are discriminated unions on type. Note the target list is capped at 100 user IDs, unlike the menu preset assignment which allows 10000.
Enter the panel session hash with the "NVX " prefix, e.g. "NVX fa7bf873fab9333144e171372a321b06". Obtain the hash from the accountAuth operation.
Which users the settings apply to. The shape depends on type.
Multi-factor authentication policy. The shape depends on type.
Successful response
true if request finished successfully.
trueBad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array.
Operation not permitted, error code 13: the session lacks the required permission.
Error response object
POST /v2/panel/user/mfa/settings/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"target": {
"type": "all"
},
"settings": {
"type": "allowed",
"factor_types": [
"email"
]
}
}{
"success": true
}Both target and settings vary by their type field. See Update target and MFA settings below.
required permissions: users: "read".
Read the dealer-level default multi-factor authentication policy, applied to users with no explicit setting.
value is null when no default has been configured. Takes no parameters beyond the session credential.
Enter the panel session hash with the "NVX " prefix, e.g. "NVX fa7bf873fab9333144e171372a321b06". Obtain the hash from the accountAuth operation.
The default policy
true if request finished successfully.
trueThe configured default, or null when none is set.
Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array.
Operation not permitted, error code 13: the session lacks the required permission.
Error response object
POST /v2/panel/user/mfa/settings/default/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*
{
"success": true,
"value": {
"type": "allowed",
"factor_types": [
"email"
]
}
}value is null when the dealer has not configured a default.
required permissions: users: "update".
Set the dealer-level default multi-factor authentication policy. It applies to users with no explicit setting of their own.
Enter the panel session hash with the "NVX " prefix, e.g. "NVX fa7bf873fab9333144e171372a321b06". Obtain the hash from the accountAuth operation.
Multi-factor authentication policy. The shape depends on type.
Successful response
true if request finished successfully.
trueBad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array.
Operation not permitted, error code 13: the session lacks the required permission.
Error response object
POST /v2/panel/user/mfa/settings/default/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"settings": {
"type": "allowed",
"factor_types": [
"email"
]
}
}{
"success": true
}The default applies to users who have no explicit setting of their own.
Types
MFA settings
factor_types is required when type is allowed, and must not be empty.
Update target
When type is selected, ids must contain between 1 and 100 user IDs. Note this is a tighter limit than the 10000 allowed by menu preset assignment.
Settings action type
allowed- MFA with the specified factor types is allowed for the users.disallowed- MFA is disallowed for the users.
Factor type
email- a multi-digit code sent by email.
Last updated
Was this helpful?