AuthenticationFactorEnrolledTotp
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
TOTP-based authentication factor details. Includes enrollment secrets only available at creation time.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $issuer : string
- Your application or company name displayed in the user's authenticator app. Defaults to your WorkOS team name.
- $qrCode : string
- Base64 encoded image containing scannable QR code.
- $secret : string
- TOTP secret that can be manually entered into some authenticator apps in place of scanning a QR code.
- $uri : string
- The `otpauth` URI that is encoded by the provided `qr_code`.
- $user : string
- The user's account name displayed in their authenticator app. Defaults to the user's email.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$issuer
Your application or company name displayed in the user's authenticator app. Defaults to your WorkOS team name.
public
string
$issuer
$qrCode
Base64 encoded image containing scannable QR code.
public
string
$qrCode
$secret
TOTP secret that can be manually entered into some authenticator apps in place of scanning a QR code.
public
string
$secret
$uri
The `otpauth` URI that is encoded by the provided `qr_code`.
public
string
$uri
$user
The user's account name displayed in their authenticator app. Defaults to the user's email.
public
string
$user
Methods
__construct()
public
__construct(string $issuer, string $user, string $secret, string $qrCode, string $uri) : mixed
Parameters
- $issuer : string
- $user : string
- $secret : string
- $qrCode : string
- $uri : string
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>