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): what it omits is not preserved. The required members are constructor parameters, so omitting one is a constructor error; an optional member left unset is omitted from the wire and takes its default server-side.

Table of Contents

Interfaces

JsonSerializable

Properties

$accessTokenLifetimeSecs  : int
$adminNotificationsEnabled  : bool
$cimd  : CimdPolicy|null
$dcrAllowedRedirectHosts  : array<string|int, mixed>|null
$dcrAllowedScopes  : array<string|int, mixed>|null
$dcrMaxClients  : int|null
$dcrUnusedClientTtlDays  : int|null
$defaultCertValidityDays  : int
$defaultLocale  : string|null
$deletionGracePeriodDays  : int|null
$dynamicRegistration  : string|null
$emailVerificationGracePeriodHours  : int
$emailVerificationRequired  : bool
$externalClientAllowedResources  : array<string|int, mixed>|null
$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
$samlIdpEnabled  : bool|null
$sensitiveScopesEnabled  : bool|null
$serverCertAllowedNames  : array<string|int, mixed>|null
$ssfEnabled  : bool|null
$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

$dcrAllowedRedirectHosts read-only

public array<string|int, mixed>|null $dcrAllowedRedirectHosts = null

$dcrAllowedScopes read-only

public array<string|int, mixed>|null $dcrAllowedScopes = null

$dcrUnusedClientTtlDays read-only

public int|null $dcrUnusedClientTtlDays = null

$defaultCertValidityDays read-only

public int $defaultCertValidityDays

$defaultLocale read-only

public string|null $defaultLocale = null

$deletionGracePeriodDays read-only

public int|null $deletionGracePeriodDays = null

$dynamicRegistration read-only

public string|null $dynamicRegistration = null

$emailVerificationGracePeriodHours read-only

public int $emailVerificationGracePeriodHours

$emailVerificationRequired read-only

public bool $emailVerificationRequired

$externalClientAllowedResources read-only

public array<string|int, mixed>|null $externalClientAllowedResources = null

$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

$samlIdpEnabled read-only

public bool|null $samlIdpEnabled = null

$sensitiveScopesEnabled read-only

public bool|null $sensitiveScopesEnabled = null

$serverCertAllowedNames read-only

public array<string|int, mixed>|null $serverCertAllowedNames = null

$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[, CimdPolicy|null $cimd = null ][, array<int, string>|null $dcrAllowedRedirectHosts = null ][, array<int, string>|null $dcrAllowedScopes = null ][, int|null $dcrMaxClients = null ][, int|null $dcrUnusedClientTtlDays = null ][, string|null $defaultLocale = null ][, int|null $deletionGracePeriodDays = null ][, string|null $dynamicRegistration = null ][, array<int, string>|null $externalClientAllowedResources = null ][, string|null $opaqueKsf = null ][, string|null $opaqueMode = null ][, string|null $opaqueSuite = null ][, bool|null $samlIdpEnabled = null ][, bool|null $sensitiveScopesEnabled = null ][, array<int, string>|null $serverCertAllowedNames = null ][, bool|null $ssfEnabled = 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

$cimd : CimdPolicy|null = null

T21.5 — defaulted, so an API client written before this task lands on enabled: false, which is what every deployment did before client ID metadata documents existed (I1). (optional)

$dcrAllowedRedirectHosts : array<int, string>|null = null

the server's dcr_allowed_redirect_hosts field (optional)

$dcrAllowedScopes : array<int, string>|null = null

the server's dcr_allowed_scopes field (optional)

$dcrMaxClients : int|null = null

the server's dcr_max_clients field (optional)

$dcrUnusedClientTtlDays : int|null = null

the server's dcr_unused_client_ttl_days field (optional)

$defaultLocale : string|null = null

the server's default_locale field (optional)

$deletionGracePeriodDays : int|null = null

the server's deletion_grace_period_days field (optional)

$dynamicRegistration : string|null = null

the server's dynamic_registration field (optional)

$externalClientAllowedResources : array<int, string>|null = null

the server's external_client_allowed_resources 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)

$samlIdpEnabled : bool|null = null

G-2 / D-20 — defaulted, so an API client written before the SAML identity provider existed lands on false, which is what every deployment did before (I1). (optional)

$sensitiveScopesEnabled : bool|null = null

the server's sensitive_scopes_enabled field (optional)

$serverCertAllowedNames : array<int, string>|null = null

S-7 — defaulted to empty, so an API client written before the field lands on "no Server certificate is issued" (I1). (optional)

$ssfEnabled : bool|null = null

G-5 / D-45 — defaulted, so an API client written before the SSF transmitter existed lands on false, which is what every deployment did before (I1). (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).

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

Search results