WorkOS PHP SDK

CreateMagicCodeAndReturn
in package
implements JsonSerializable uses JsonSerializableTrait

Read onlyYes

Table of Contents

Interfaces

JsonSerializable

Properties

$email  : string
The email address to send the magic code to.
$invitationToken  : string|null
The invitation token to associate with this magic code.
$ipAddress  : string|null
The IP address of the user's request.
$radarAuthAttemptId  : string|null
The ID of an existing Radar authentication attempt to associate with this request.
$signalsId  : string|null
An optional Radar signals ID to correlate client-side signals with this request.
$userAgent  : string|null
The user agent string from the user's request.

Methods

__construct()  : mixed
fromArray()  : self
jsonSerialize()  : array<string|int, mixed>
toArray()  : array<string|int, mixed>

Properties

$invitationToken

The invitation token to associate with this magic code.

public string|null $invitationToken = null

$radarAuthAttemptId

The ID of an existing Radar authentication attempt to associate with this request.

public string|null $radarAuthAttemptId = null

$signalsId

An optional Radar signals ID to correlate client-side signals with this request.

public string|null $signalsId = null

Methods

__construct()

public __construct(string $email[, string|null $invitationToken = null ][, string|null $ipAddress = null ][, string|null $userAgent = null ][, string|null $radarAuthAttemptId = null ][, string|null $signalsId = null ]) : mixed
Parameters
$email : string
$invitationToken : string|null = null
$ipAddress : string|null = null
$userAgent : string|null = null
$radarAuthAttemptId : string|null = null
$signalsId : string|null = null

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results