EnrollUserAuthenticationFactor
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $totpIssuer : string|null
- Your application or company name displayed in the user's authenticator app.
- $totpSecret : string|null
- The Base32-encoded shared secret for TOTP factors. This can be provided when creating the auth factor, otherwise it will be generated. The algorithm used to derive TOTP codes is SHA-1, the code length is 6 digits, and the timestep is 30 seconds – the secret must be compatible with these parameters.
- $totpUser : string|null
- The user's account name displayed in their authenticator app.
- $type : string
- The type of the factor to enroll.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$totpIssuer
Your application or company name displayed in the user's authenticator app.
public
string|null
$totpIssuer
= null
$totpSecret
The Base32-encoded shared secret for TOTP factors. This can be provided when creating the auth factor, otherwise it will be generated. The algorithm used to derive TOTP codes is SHA-1, the code length is 6 digits, and the timestep is 30 seconds – the secret must be compatible with these parameters.
public
string|null
$totpSecret
= null
$totpUser
The user's account name displayed in their authenticator app.
public
string|null
$totpUser
= null
$type
The type of the factor to enroll.
public
string
$type
Methods
__construct()
public
__construct(string $type[, string|null $totpIssuer = null ][, string|null $totpUser = null ][, string|null $totpSecret = null ]) : mixed
Parameters
- $type : string
- $totpIssuer : string|null = null
- $totpUser : string|null = null
- $totpSecret : string|null = null
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>