Newer Version Available

This content describes an older version of this product. View Latest

TwoFactorInfo

Stores a user’s secret for two-factor operations. Use this object when customizing two-factor authentication in your organization. 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 Two-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 two-factor method.
  • TOTP—The time-based one-time password.
  • HOTP—Reserved for future use.
UserId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID for the user who’s associated with the authentication secret.