Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

TwoFactorInfo

Stores a user’s secret for multi-factor operations. Use this object when customizing multi-factor authentication in your organization. (Note that multi-factor authentication was formerly called two-factor authentication.) This object is available in API version 32.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

You need the Manage Multi-Factor Authentication in API permission to create or update this object.

Fields

Field Name Details
SharedKey
Type
string
Properties
Create, Group, Sort, Update
Description

This field is never read-enabled, though it is write-enabled. A request for this value always returns null. The value must be a base32-encoded string of a 20-byte secret.

You can use the Apex method Auth.SessionManagement.getQrCode() to get a value to write to this field.

If you write a secret to this field, in API version 37.0 and later the user gets an email notification that a new identity verification method was added to the user’s account.

Note

Type
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The multi-factor method.
  • TOTP—The time-based one-time password.
UserId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID for the user who’s associated with the authentication secret.