AXIAM PHP SDK

TenantSettingsOverride
in package
implements JsonSerializable

FinalYes

Partial tenant overrides. `None` = inherit from org baseline.

Every property is optional, so this is a SPARSE body: what you leave unset is left unchanged, and is omitted from the wire request entirely rather than sent as null (§27.4 rule 5).

Table of Contents

Interfaces

JsonSerializable

Properties

$accessTokenLifetimeSecs  : int|null
$adminNotificationsEnabled  : bool|null
$cimd  : CimdPolicy|null
$dcrAllowedRedirectHosts  : array<string|int, mixed>|null
$dcrAllowedScopes  : array<string|int, mixed>|null
$dcrMaxClients  : int|null
$dcrUnusedClientTtlDays  : int|null
$defaultCertValidityDays  : int|null
$defaultLocale  : string|null
$deletionGracePeriodDays  : int|null
$dynamicRegistration  : string|null
$emailVerificationGracePeriodHours  : int|null
$emailVerificationRequired  : bool|null
$externalClientAllowedResources  : array<string|int, mixed>|null
$hibpCheckEnabled  : bool|null
$lockoutBackoffMultiplier  : float|null
$lockoutDurationSecs  : int|null
$maxCertValidityDays  : int|null
$maxFailedLoginAttempts  : int|null
$maxLockoutDurationSecs  : int|null
$mfaChallengeLifetimeSecs  : int|null
$mfaEnforced  : bool|null
$minLength  : int|null
$opaqueKsf  : string|null
$opaqueMode  : string|null
$opaqueSuite  : string|null
$passwordHistoryCount  : int|null
$refreshTokenLifetimeSecs  : int|null
$requireDigits  : bool|null
$requireLowercase  : bool|null
$requireSymbols  : bool|null
$requireUppercase  : bool|null
$samlIdpEnabled  : bool|null
$sensitiveScopesEnabled  : bool|null
$serverCertAllowedNames  : array<string|int, mixed>|null
$ssfEnabled  : bool|null
$webauthnUserVerification  : string|null

Methods

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

$dcrAllowedRedirectHosts read-only

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

$emailVerificationGracePeriodHours read-only

public int|null $emailVerificationGracePeriodHours = null

$externalClientAllowedResources read-only

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

$serverCertAllowedNames read-only

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

Methods

__construct()

Constructs a TenantSettingsOverride.

public __construct([int|null $accessTokenLifetimeSecs = null ][, bool|null $adminNotificationsEnabled = null ][, CimdPolicy|null $cimd = null ][, array<int, string>|null $dcrAllowedRedirectHosts = null ][, array<int, string>|null $dcrAllowedScopes = null ][, int|null $dcrMaxClients = null ][, int|null $dcrUnusedClientTtlDays = null ][, int|null $defaultCertValidityDays = null ][, string|null $defaultLocale = null ][, int|null $deletionGracePeriodDays = null ][, string|null $dynamicRegistration = null ][, int|null $emailVerificationGracePeriodHours = null ][, bool|null $emailVerificationRequired = null ][, array<int, string>|null $externalClientAllowedResources = null ][, bool|null $hibpCheckEnabled = null ][, float|null $lockoutBackoffMultiplier = null ][, int|null $lockoutDurationSecs = null ][, int|null $maxCertValidityDays = null ][, int|null $maxFailedLoginAttempts = null ][, int|null $maxLockoutDurationSecs = null ][, int|null $mfaChallengeLifetimeSecs = null ][, bool|null $mfaEnforced = null ][, int|null $minLength = null ][, string|null $opaqueKsf = null ][, string|null $opaqueMode = null ][, string|null $opaqueSuite = null ][, int|null $passwordHistoryCount = null ][, int|null $refreshTokenLifetimeSecs = null ][, bool|null $requireDigits = null ][, bool|null $requireLowercase = null ][, bool|null $requireSymbols = null ][, bool|null $requireUppercase = 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|null = null

the server's access_token_lifetime_secs field (optional)

$adminNotificationsEnabled : bool|null = null

the server's admin_notifications_enabled field (optional)

$cimd : CimdPolicy|null = null

the server's cimd field (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)

$defaultCertValidityDays : int|null = null

the server's default_cert_validity_days field (optional)

$defaultLocale : string|null = null

The tenant's fallback UI language. Not ordered, therefore not validated against the baseline and never clamped — see [OidcPolicy]. (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)

$emailVerificationGracePeriodHours : int|null = null

the server's email_verification_grace_period_hours field (optional)

$emailVerificationRequired : bool|null = null

the server's email_verification_required field (optional)

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

the server's external_client_allowed_resources field (optional)

$hibpCheckEnabled : bool|null = null

the server's hibp_check_enabled field (optional)

$lockoutBackoffMultiplier : float|null = null

the server's lockout_backoff_multiplier field (optional)

$lockoutDurationSecs : int|null = null

the server's lockout_duration_secs field (optional)

$maxCertValidityDays : int|null = null

the server's max_cert_validity_days field (optional)

$maxFailedLoginAttempts : int|null = null

the server's max_failed_login_attempts field (optional)

$maxLockoutDurationSecs : int|null = null

the server's max_lockout_duration_secs field (optional)

$mfaChallengeLifetimeSecs : int|null = null

the server's mfa_challenge_lifetime_secs field (optional)

$mfaEnforced : bool|null = null

the server's mfa_enforced field (optional)

$minLength : int|null = null

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

$passwordHistoryCount : int|null = null

the server's password_history_count field (optional)

$refreshTokenLifetimeSecs : int|null = null

the server's refresh_token_lifetime_secs field (optional)

$requireDigits : bool|null = null

the server's require_digits field (optional)

$requireLowercase : bool|null = null

the server's require_lowercase field (optional)

$requireSymbols : bool|null = null

the server's require_symbols field (optional)

$requireUppercase : bool|null = null

the server's require_uppercase field (optional)

$samlIdpEnabled : bool|null = null

G-2 / D-20 — disable-only, like sensitive_scopes_enabled; see [OidcPolicy::saml_idp_enabled]. (optional)

$sensitiveScopesEnabled : bool|null = null

the server's sensitive_scopes_enabled field (optional)

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

S-7 — tighten-only: every entry must be covered by an organization entry. An empty list means this tenant issues no Server certificate at all, which is different from an absent field (inherit the organization's list). (optional)

$ssfEnabled : bool|null = null

G-5 / D-45 — disable-only, like saml_idp_enabled; see [OidcPolicy::ssf_enabled]. (optional)

$webauthnUserVerification : string|null = null

the server's webauthn_user_verification field (optional)

fromArray()

Rebuilds a TenantSettingsOverride 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