CreateUserRequest
in package
implements
JsonSerializable
The `CreateUserRequest` schema from the server's OpenAPI document.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $email : string
- $metadata : mixed
- $opaque : OpaqueEnrollment|null
- $password : Sensitive
- $username : string
Methods
- __construct() : mixed
- Constructs a CreateUserRequest.
- fromArray() : self
- Rebuilds a CreateUserRequest from one decoded JSON object.
- jsonSerialize() : array<string, mixed>
- Renders this object for `json_encode()`.
- toArray() : array<string, mixed>
- Renders this object back to its wire form.
Properties
$email read-only
public
string
$email
$metadata read-only
public
mixed
$metadata
= null
$opaque read-only
public
OpaqueEnrollment|null
$opaque
= null
$password read-only
public
Sensitive
$password
$username read-only
public
string
$username
Methods
__construct()
Constructs a CreateUserRequest.
public
__construct(string $email, Sensitive $password, string $username[, mixed $metadata = null ][, OpaqueEnrollment|null $opaque = null ]) : mixed
Parameters
- $email : string
-
the server's
emailfield - $password : Sensitive
-
the server's
passwordfield — a one-time secret (§27.5) - $username : string
-
the server's
usernamefield - $metadata : mixed = null
-
the server's
metadatafield (optional) - $opaque : OpaqueEnrollment|null = null
-
the server's
opaquefield (optional)
fromArray()
Rebuilds a CreateUserRequest from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selfjsonSerialize()
Renders this object for `json_encode()`.
public
jsonSerialize() : array<string, mixed>
Any Sensitive it carries stays WRAPPED here, so a log line or a
json_encode($model) in application code prints [SENSITIVE]. The one place a secret
is revealed is ManagementTransport, on the way to the wire
and nowhere else (§27.5).
Return values
array<string, mixed>toArray()
Renders this object back to its wire form.
public
toArray() : array<string, mixed>
§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.