PingOne Platform APIs

PingOne MFA

The PingOne MFA services provide capabilities for enabling MFA actions in authentication flows, configuring MFA settings and policies, and specifying MFA devices.

PingOne MFA components

The PingOne MFA service provides these capabilities to provide MFA protection for your organization’s network, applications, and data resources.

  • MFA authentication. The /deviceAuthentications endpoint initiates and completes an MFA action without requiring a call to the PingOne authorize service. It supports actions to select a supported MFA device type and to validate a one-time passcode (OTP). Refer to MFA device authentications.

  • MFA policies and settings. The MFA settings endpoint supports operations to read, update, and reset the PingOne MFA settings associated with a specified environment. Refer to MFA settings. The Device authentication policies (identified in the PingOne UI as "MFA Policies") enable you to configure different settings per MFA authentication method, according to your security policies. Refer to Device authentication policies.

  • MFA device management. The enable user settings (MFA) control whether a user can authenticate using MFA actions. This endpoint enables or disables MFA capability. Refer to Enable users MFA. The MFA devices service defines the MFA method or methods associated with a user, such as email, SMS, voice, or other MFA device types for use in an MFA flow. Refer to MFA devices. To enable multi-factor authentication (MFA) via push notification on a native device, the user resource must have a native device and an application associated with its user ID. The association is implemented with a pairing key. Refer to MFA pairing keys.

These requests require PING_ONE_MFA in the Bill of Materials (BOM) for your environment. To check the BOM for the list of PingOne products associated with your environment, refer to Read one bill of materials. If PING_ONE_MFA is not in the BOM, contact your PingOne administrator to check whether your license supports adding this product to your environment.

Authentication methods

PingOne MFA supports the following authentication methods:

Authentication Method Reference (amr) Description

EMAIL

OTP through email

MCA

Multiple-channel authentication, indicating that an out-of-band operation through mobile push, either interactive or "silent"

MFA

Multi-factor authentication, indicating some MFA method, as opposed to a Bypass scenario

OTP

Time-based one-time passcode using an authenticator application or mobile OTP

SMS

OTP through SMS text message

SWK

Software-secured key, indicating device authorization using a trusted mobile device

TEL

OTP through a phone call

USER

User presence test, indicating an interactive push notification approved by the user, as opposed to a non-interactive "silent" push notification

Note The mobile application can pass any string (such as as face, ftp, pin, etc.) as AMR using the approve() method to indicate how the user approved the authorization on a push notification flow. Refer to PingOne MFA SDK for Android.

Why use PingOne MFA

MFA addresses the security challenge of verifying that a user requesting access to a protected resource is who they claim to be and that they’re permitted to access the requested resource. Passwords alone can be compromised through overuse, phishing, or theft, creating a security risk.

PingOne MFA protects against compromised passwords by requiring users to provide multiple verification factors before granting access:

  • Stronger than a password. MFA combines factor types, such as something you know (a password or PIN) with something you have (a phone, hardware token, or security key), and something you are (a biometric). With MFA enabled, a single stolen credential does not expose the account.

  • Enables passwordless sign-on. FIDO2 biometrics, passkeys, and security keys can replace passwords, reducing the risk of phishing, password spraying, and credential stuffing. Passwordless methods reduce exposure to username enumeration, MFA fatigue attacks, and targeted phishing.

  • Meets users where they are. With methods ranging from FIDO2 and mobile push to SMS, voice, and email OTP, you can offer strong authentication to every user population.

  • Adapts to the scenario. MFA can be applied as a step-up after password sign-on, as a condition of an authentication policy. For example, an MFA action can be added in cases when users haven’t signed on recently, or because of a high risk score based on a risk evaluation.

How MFA works

PingOne MFA operates inside the application’s authentication flow. When a flow requires strong authentication, MFA verifies the user with one or more of the user’s registered devices or credentials. The workflow includes these steps:

  1. An administrator configures the service. The administrator configures MFA settings, an MFA policy that enables and configures the authentication methods for the environment, and an authentication policy that dictates how the user’s identity is verified.

  2. The user enrolls a device. Before a user can authenticate with a method, the device or credential for that method must be registered to the user. The user pairs the PingOne mobile application, registers a passkey, or has an SMS, email, voice, or OATH token device defined. For push notifications on a native device, the user resource must have a native device and an application associated with its user ID through a pairing key.

  3. The client initiates an MFA action. The application, flow, or integration kit initiates the MFA action to select a device and start the verification.

  4. The user verifies their identity. The service sends the challenge for the selected method: a push notification, an OTP by SMS, voice, or email, a time-based passcode from an authenticator app, a FIDO2 biometric or passkey prompt, or an OATH token code. The user responds to the prompt.

  5. The service validates the response. PingOne MFA validates the user response and returns the result. The authentication method reference (amr) value in the result indicates how the user authenticated.

  6. The flow continues. Based on the MFA result, the flow grants access, re-prompts, continues to another sign-on action, or fails.

PingOne MFA integrations

You can introduce strong authentication at different points in a flow. Here are some common integration points:

  • PingOne authentication policies. For environments that are not integrated with DaVinci, configure an authentication policy. A multi-factor policy can require a TOTP authenticator app, FIDO2 biometrics, a push notification to the user’s mobile device, or a one-time passcode sent over SMS, voice, or email. You can also determine whether users who don’t have any enrolled MFA devices can bypass the MFA flow or are blocked from sign-on.

  • DaVinci flows. Add the PingOne MFA connector to a flow to add MFA, including passwordless login flows. The connector handles device enrollment and verification inside the flow, and you can pair it with the PingOne Protect connector to issue MFA challenges only in high-risk situations.

  • PingFederate. Use the PingOne MFA Integration Kit (or the bundled PingOne MFA adapter) to add PingOne MFA to a PingFederate authentication policy, with use cases such as transaction approval, passwordless login using FIDO browser management, a stateless one-time device OTP flow, and FIDO usernameless authentication. Automatic device pairing lets users pair the mobile app the first time they authenticate with an unpaired device.

  • PingOne Advanced Identity Cloud and PingAM journeys. Use the MFA authentication nodes in your journeys, with methods including OATH authenticator apps, push notifications, and WebAuthn devices and passkeys for passwordless and usernameless authentication.

  • Direct API calls. Manage devices and perform MFA directly from your application through the MFA API. Enable MFA for the user, create and list the user’s MFA devices, create pairing keys for the native mobile app, and initiate and complete device authentications. For a richer native experience, use the PingOne MFA mobile SDKs for Android and iOS to embed MFA in your apps.

  • Workforce with PingID. For workforce scenarios, PingID is the cloud-based, adaptive MFA solution in most geographies (the Singapore geography uses PingOne MFA for both workforce and customer environments). PingID integrates with PingOne SSO, PingFederate SSO, VPN and remote access systems, Windows and Mac login, SSH, AD FS, and Microsoft Entra ID.

All methods are enabled and configured in the MFA policy, but some authentication methods require additional configuration steps outside of the MFA policy, and the methods available depend on your geography and license. Workforce and customer options include FIDO2 (passkeys), authenticator app, email, SMS or voice, OATH token, and native mobile application. Workforce only adds the PingID mobile app, YubiKey, and the PingID desktop app.