Multi-factor authentication settings¶

API actions¶

API path: panel/user/mfa/settings.

update¶

Updates users' MFA settings.

required permissions: users: "update".

parameters¶

Update target¶

example¶

curl -X POST 'https://api.navixy.com/v2/panel/user/mfa/settings/update' \
    -H 'Authorization: NVX 22eac1c27af4be7b9d04da2ce1af111b' \
    -H 'Content-Type: application/json' \
    -d '{ "target": { "type": "all" }, "settings": { "type": "disallowed" } }'

response¶

{
  "success": true
}

errors¶

• 201 – Not found in the database — if the specified user does not exist or belongs to a different dealer.

read default¶

Reads default MFA settings which are applied to the newly created users.

required permissions: users: "read".

example¶

curl -X POST 'https://api.navixy.com/v2/panel/user/mfa/settings/default/read' \
    -H 'Authorization: NVX 22eac1c27af4be7b9d04da2ce1af111b'

response¶

{
  "success": true,
  "value": {
    "type": "disallowed"
  }
}

• value - optional MFA settings.

update default¶

Updates default MFA settings which are applied to the newly created users.

required permissions: users: "update".

parameters¶

example¶

curl -X POST 'https://api.navixy.com/v2/panel/user/mfa/settings/default/update' \
    -H 'Authorization: NVX 22eac1c27af4be7b9d04da2ce1af111b' \
    -H 'Content-Type: application/json' \
    -d '{ "settings": { "type": "disallowed" } }'

response¶

{
  "success": true
}

Types¶

MFA settings¶

{
  "type": "allowed",
  "factor_types": ["email"]
}

• type - settings action type.
• factor_types - optional array of factor types. Required if type is allowed.

Settings action type¶

• allowed - MFA with specified types is allowed for the users.
• disallowed - MFA is disallowed for the users.

Factor type¶

• email - a multi-digit code sent by email.