Skip to content
D
Documentation

Two-factor authentication

reference
7 min readUpdated

Two-factor authentication adds an authentication step for selected users. This configuration controls where verification codes are sent and which devices remain trusted.

Two-factor authentication at a glance

This configuration screen brings together user settings, trusted devices, and the modification history entry point. A trusted device is a device that remains recognised for a user.

If you need to…Go to
Review user two-factor settingsTwo-factor authentication fields
Review trusted devicesTrusted-device fields
Change a user's settingsMaintain user two-factor settings
Review modification historyReview trusted devices and modifications
Return to the wider configuration areaConfiguration dashboard
Continue with user recordsUser-management pages for user records

The two-factor area is a configuration table rather than the user-record form. User-record two-factor fields remain with the user-management pages.

The two-factor settings surface with its user rows and save actions

Before you start

You need access to the configuration area and a loaded company context before this screen can show all of its surfaces. Save and Save and Close are available only with edit permission; both are disabled while no data changes exist. The Last Modifications area appears only when a company identifier is loaded.

Use the values and rows currently displayed. Initial checkbox selections, the exact number of user rows, and a device row's action state depend on the loaded company data.

Find the Two-factor authentication screen

Open the configuration screen from the 2-Factor authentication menu entry.

Prerequisites

  • You are signed in and can open the Configuration menu.

Steps

  1. Open the Configuration menu.
  2. Select 2-Factor authentication.
  3. Confirm that 2-Factor authentication is visible.
The opened Two-factor authentication screen

Result: The Two-factor authentication screen is open on the two-factor surface.

Understand the screen and its fields

The screen separates user settings from device review. The 2-Factor authentication tab contains the user settings grid. The Trusted devices tab contains the trusted-device grid. Save and Save and Close commit settings when edit permission is present and data has changed. Last Modifications opens the history surface when a company identifier is loaded.

SurfaceWhat it contains or does
2-Factor authenticationUser rows and two-factor, delivery-method, and destination controls.
Trusted devicesDevice rows with user, device, trust, location, and login-date information.
SaveSends changed two-factor settings and refreshes history after a normal save.
Save and CloseSends changed settings and leaves the page after a successful save.
Last ModificationsOpens the modification-history surface when a company identifier is loaded.
The Trusted devices tab with its device grid

Two-factor authentication fields

The two-factor grid shows one row per user presented by the loaded configuration. Its controls describe whether two-factor authentication applies, how a verification code is delivered, and which destination receives it.

Column or controlWhat it representsAvailability
UserThe user represented by the row.A two-factor row surface.
Apply 2 factor authenticationThe user's two-factor setting.Selecting it changes that user's setting and updates the email setting.
Send verification codeThe grouped delivery choices.Contains the delivery controls below.
By mailMail delivery choice.Disabled in the visible table.
By SMSSMS delivery choice.Disabled in the visible table.
To admin.Sends the verification destination to the administrator option.Disabled when the row's two-factor setting is disabled.
To userSends the verification destination to the user option.Disabled when the row's two-factor setting is disabled.

The To admin. and To user controls are row-level choices. Enablement follows the row's Apply 2 factor authentication setting; it is not a separate screen-wide switch.

The Send verification code group and its delivery choices

Trusted-device fields

Select Trusted devices to review the device rows.

ColumnWhat the row presents
UserThe user associated with the device.
Device nameThe device's name.
Trusted machineWhether the device is trusted.
LocationThe device location.
First login atThe first recorded login time for the device.
Last login atThe most recent recorded login time for the device.

The trusted-device grid does not provide a column chooser. Work from the headers shown in the grid.

Maintain user two-factor settings

Change a user's setting and verification-code destination from the user row. Apply 2 factor authentication changes the selected user's setting and updates the email setting. To admin. and To user change that user's destination flags.

Prerequisites

  • The Two-factor authentication screen is open.
  • You have edit permission.
  • The user row you need is visible.

Steps

  1. In the user row, select or clear Apply 2 factor authentication.

  2. In the same row, choose one destination.

    If the verification code should go to…Select
    The administratorTo admin.
    The userTo user

    The selected destination is applied to that user's destination flags.

  3. Select Save to keep the page open, or select Save and Close to leave after saving.

    If you need to…SelectThen expect…
    Save and continue reviewing this screenSaveThe settings are sent and the history is refreshed after a normal save.
    Save and leave the screenSave and CloseThe settings are sent and the page closes after a successful save.
  4. Confirm the success message Your request was completed successfully.

If the save request fails, the screen displays An error occurred while processing your request.

Result: The selected save action has completed, and the success message is visible when the save succeeds.

Review trusted devices and modifications

Review device rows first, then open the history surface when a company identifier is loaded.

Prerequisites

  • The Two-factor authentication screen is open.
  • A company identifier is loaded when you need the history area.

Steps

  1. Select Trusted devices.
  2. Review User, Device name, Trusted machine, Location, First login at, and Last login at.
  3. Select Last Modifications.
  4. Review the history surface for the loaded company.
The Last Modifications history entry point and history surface

Result: The trusted-device grid or the modification-history surface is open, depending on the last control you selected.

Handle trusted-device actions

The action on a trusted-device row depends on its trust state. A trusted device exposes Untrust; an untrusted device exposes Delete. Each action opens a confirmation menu before the operation is called.

Prerequisites

  • The Trusted devices tab is open.
  • A device row exposes its action.

Steps

  1. Select the action exposed by the device row.

    If the row exposesReviewTo complete the actionTo leave the row unchanged
    UntrustAre you sure you want to untrust this device?Select Delete.Select Cancel.
    DeleteAre you sure you want to delete this device?Select Delete.Select Cancel.
A trusted-device row with its available action and confirmation menu

The available action belongs to the individual row. Use the confirmation text before committing a device change.

Result: The confirmation menu is either closed with Cancel or submitted with Delete for the selected device action.

When a setting or device action does not work

Use this table to match what you see with the condition that controls the surface.

What you seeWhat it meansWhat to do
Save is disabled.No data changes exist.Change a supported user setting first, then check Save again.
Last Modifications is absent.No company identifier is loaded.Load the company context before opening history.
The first two-factor grid is absent.That grid declaration is behind a false display guard.Use the visible two-factor table and its row controls.
A required-field message does not appear.This screen declares no required-field or validation rules.Review the row controls and save state rather than looking for a field-validation panel.
The save request reports an error.The request was not completed.Review the changed settings and contact your administrator if the error continues. The message is An error occurred while processing your request.
The initial values or row count differ from an example.Loaded data determines the checkbox values and exact rows.Work from the values and rows currently displayed.

What to do next

This page manages the configuration table. Continue to the Configuration dashboard for another configuration area. For user-record details, continue to the user-management pages. User-record two-factor fields are outside this page.

Shared log-history filters, registration details, and generic popup actions such as Don't Save, Upload, No, Yes, Ok, and Back belong to their owning shared surfaces rather than this configuration page.

  • Continue to the Configuration dashboard for another configuration area.
  • Continue to the user-management pages for user-record details.

Was this page helpful?

Need help using the product?