AXIAM PHP SDK

SetOrgSettings
in package
implements JsonSerializable

FinalYes

Input for setting organization-level security settings.

This is a REPLACEMENT body (§27.4 rule 5): every field is required, so omitting one is a constructor error rather than a silent erasure server-side.

Table of Contents

Interfaces

JsonSerializable

Properties

$accessTokenLifetimeSecs  : int
$adminNotificationsEnabled  : bool
$defaultCertValidityDays  : int
$deletionGracePeriodDays  : int|null
$emailVerificationGracePeriodHours  : int
$emailVerificationRequired  : bool
$hibpCheckEnabled  : bool
$lockoutBackoffMultiplier  : float
$lockoutDurationSecs  : int
$maxCertValidityDays  : int
$maxFailedLoginAttempts  : int
$maxLockoutDurationSecs  : int
$mfaChallengeLifetimeSecs  : int
$mfaEnforced  : bool
$minLength  : int
$opaqueKsf  : string|null
$opaqueMode  : string|null
$opaqueSuite  : string|null
$passwordHistoryCount  : int
$refreshTokenLifetimeSecs  : int
$requireDigits  : bool
$requireLowercase  : bool
$requireSymbols  : bool
$requireUppercase  : bool
$webauthnUserVerification  : string|null

Methods

__construct()  : mixed
Constructs a SetOrgSettings.
fromArray()  : self
Rebuilds a SetOrgSettings 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

$accessTokenLifetimeSecs read-only

public int $accessTokenLifetimeSecs

$adminNotificationsEnabled read-only

public bool $adminNotificationsEnabled

$defaultCertValidityDays read-only

public int $defaultCertValidityDays

$deletionGracePeriodDays read-only

public int|null $deletionGracePeriodDays = null

$emailVerificationGracePeriodHours read-only

public int $emailVerificationGracePeriodHours

$emailVerificationRequired read-only

public bool $emailVerificationRequired

$lockoutBackoffMultiplier read-only

public float $lockoutBackoffMultiplier

$maxFailedLoginAttempts read-only

public int $maxFailedLoginAttempts

$maxLockoutDurationSecs read-only

public int $maxLockoutDurationSecs

$mfaChallengeLifetimeSecs read-only

public int $mfaChallengeLifetimeSecs

$passwordHistoryCount read-only

public int $passwordHistoryCount

$refreshTokenLifetimeSecs read-only

public int $refreshTokenLifetimeSecs

$webauthnUserVerification read-only

public string|null $webauthnUserVerification = null

Methods

__construct()

Constructs a SetOrgSettings.

public __construct(int $accessTokenLifetimeSecs, bool $adminNotificationsEnabled, int $defaultCertValidityDays, int $emailVerificationGracePeriodHours, bool $emailVerificationRequired, bool $hibpCheckEnabled, float $lockoutBackoffMultiplier, int $lockoutDurationSecs, int $maxCertValidityDays, int $maxFailedLoginAttempts, int $maxLockoutDurationSecs, int $mfaChallengeLifetimeSecs, bool $mfaEnforced, int $minLength, int $passwordHistoryCount, int $refreshTokenLifetimeSecs, bool $requireDigits, bool $requireLowercase, bool $requireSymbols, bool $requireUppercase[, int|null $deletionGracePeriodDays = null ][, string|null $opaqueKsf = null ][, string|null $opaqueMode = null ][, string|null $opaqueSuite = null ][, string|null $webauthnUserVerification = null ]) : mixed
Parameters
$accessTokenLifetimeSecs : int

the server's access_token_lifetime_secs field

$adminNotificationsEnabled : bool

the server's admin_notifications_enabled field

$defaultCertValidityDays : int

the server's default_cert_validity_days field

$emailVerificationGracePeriodHours : int

the server's email_verification_grace_period_hours field

$emailVerificationRequired : bool

the server's email_verification_required field

$hibpCheckEnabled : bool

the server's hibp_check_enabled field

$lockoutBackoffMultiplier : float

the server's lockout_backoff_multiplier field

$lockoutDurationSecs : int

the server's lockout_duration_secs field

$maxCertValidityDays : int

the server's max_cert_validity_days field

$maxFailedLoginAttempts : int

the server's max_failed_login_attempts field

$maxLockoutDurationSecs : int

the server's max_lockout_duration_secs field

$mfaChallengeLifetimeSecs : int

the server's mfa_challenge_lifetime_secs field

$mfaEnforced : bool

the server's mfa_enforced field

$minLength : int

the server's min_length field

$passwordHistoryCount : int

the server's password_history_count field

$refreshTokenLifetimeSecs : int

the server's refresh_token_lifetime_secs field

$requireDigits : bool

the server's require_digits field

$requireLowercase : bool

the server's require_lowercase field

$requireSymbols : bool

the server's require_symbols field

$requireUppercase : bool

the server's require_uppercase field

$deletionGracePeriodDays : int|null = null

the server's deletion_grace_period_days field (optional)

$opaqueKsf : string|null = null

the server's opaque_ksf field (optional)

$opaqueMode : string|null = null

the server's opaque_mode field (optional)

$opaqueSuite : string|null = null

the server's opaque_suite field (optional)

$webauthnUserVerification : string|null = null

the server's webauthn_user_verification field (optional)

fromArray()

Rebuilds a SetOrgSettings 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).

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>
On this page

Search results