AXIAM PHP SDK

SecuritySettings
in package
implements JsonSerializable

FinalYes

Fully resolved security settings (all fields present).

Table of Contents

Interfaces

JsonSerializable

Properties

$certificate  : CertificatePolicy
$createdAt  : string
$email  : EmailVerificationPolicy
$id  : string
$lockout  : LockoutPolicy
$mfa  : MfaPolicy
$notification  : NotificationPolicy
$oidc  : OidcPolicy
$opaque  : OpaquePolicy
$password  : PasswordPolicy
$privacy  : PrivacyPolicy
$scope  : SettingsScope
$scopeId  : string
$token  : TokenPolicy
$updatedAt  : string
$webauthn  : WebauthnPolicy

Methods

__construct()  : mixed
Constructs a SecuritySettings.
fromArray()  : self
Rebuilds a SecuritySettings 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.
unknownEnumValue()  : string|null
The string the server sent for an open-enum member this SDK has no name for, or `null`.

Properties

Methods

__construct()

Constructs a SecuritySettings.

public __construct(CertificatePolicy $certificate, string $createdAt, EmailVerificationPolicy $email, string $id, LockoutPolicy $lockout, MfaPolicy $mfa, NotificationPolicy $notification, OidcPolicy $oidc, OpaquePolicy $opaque, PasswordPolicy $password, PrivacyPolicy $privacy, SettingsScope $scope, string $scopeId, TokenPolicy $token, string $updatedAt, WebauthnPolicy $webauthn) : mixed
Parameters
$certificate : CertificatePolicy

the server's certificate field

$createdAt : string

the server's created_at field

$email : EmailVerificationPolicy

the server's email field

$id : string

the server's id field

$lockout : LockoutPolicy

the server's lockout field

$mfa : MfaPolicy

the server's mfa field

$notification : NotificationPolicy

the server's notification field

$oidc : OidcPolicy

the server's oidc field

$opaque : OpaquePolicy

the server's opaque field

$password : PasswordPolicy

the server's password field

$privacy : PrivacyPolicy

the server's privacy field

$scope : SettingsScope

the server's scope field

$scopeId : string

the server's scope_id field

$token : TokenPolicy

the server's token field

$updatedAt : string

the server's updated_at field

$webauthn : WebauthnPolicy

the server's webauthn field

fromArray()

Rebuilds a SecuritySettings from one decoded JSON object.

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

The raw wire object.

Return values
self

jsonSerialize()

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).

Rendering for a log line never fails: an unknown union arm renders its discriminator and an unrecognised enum value its empty Unknown spelling here, and only self::toArray() -- the request path -- refuses to send it (CONTRACT.md §31.2, §34.2 P12.2).

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.

Return values
array<string, mixed>

unknownEnumValue()

The string the server sent for an open-enum member this SDK has no name for, or `null`.

public unknownEnumValue(string $wire) : string|null

Only a model decoded by self::fromArray() knows it, and only for a member that decoded to Unknown (CONTRACT.md §27.6.2 item 4, §34.8 (c)): it lets a refusal name the value. It is for messages -- it is never rendered by self::toArray() or self::jsonSerialize() and so is never sent.

Parameters
$wire : string

The member's wire name.

Return values
string|null
On this page

Search results