AXIAM PHP SDK

UpdateDirectoryConfig
in package
implements JsonSerializable

FinalYes

`PATCH /api/v1/tenants/{tenant_id}/directory` — a **sparse** update. Every member optional: absent leaves the stored value, and for the two nullable members an explicit `null` clears it.

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

$baseDn  : string|null
$bindDn  : string|null
$bindSecret  : Sensitive|null
$enabled  : bool|null
$groupBaseDn  : string|JsonNull|null
$groupFilter  : string|JsonNull|null
$groupMappings  : array<string|int, mixed>|null
$groupMemberAttribute  : string|null
$groupNestingDepth  : int|null
$jitProvisioning  : bool|null
$kind  : DirectoryKind|null
$startTls  : bool|null
$syncIntervalSecs  : int|null
$trustAnchorsPem  : array<string|int, mixed>|null
$url  : string|null
$userAttributeMap  : UserAttributeMap|null
$userFilter  : string|null

Methods

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

public __construct([string|null $baseDn = null ][, string|null $bindDn = null ][, Sensitive|null $bindSecret = null ][, bool|null $enabled = null ][, string|JsonNull|null $groupBaseDn = null ][, string|JsonNull|null $groupFilter = null ][, array<int, GroupMapping>|null $groupMappings = null ][, string|null $groupMemberAttribute = null ][, int|null $groupNestingDepth = null ][, bool|null $jitProvisioning = null ][, DirectoryKind|null $kind = null ][, bool|null $startTls = null ][, int|null $syncIntervalSecs = null ][, array<int, string>|null $trustAnchorsPem = null ][, string|null $url = null ][, UserAttributeMap|null $userAttributeMap = null ][, string|null $userFilter = null ]) : mixed
Parameters
$baseDn : string|null = null

See [SetDirectoryConfig::base_dn]. (optional)

$bindDn : string|null = null

See [SetDirectoryConfig::bind_dn]. (optional)

$bindSecret : Sensitive|null = null

See [SetDirectoryConfig::bind_secret]; absent keeps the stored secret, subject to the same P23W2-01 rule. (optional)

$enabled : bool|null = null

See [SetDirectoryConfig::enabled]. (optional)

$groupBaseDn : string|JsonNull|null = null

Explicit null clears it. null leaves the member ABSENT; JsonNull::Null is an explicit JSON null, which is not the same thing (§27.4 rule 5). (optional)

$groupFilter : string|JsonNull|null = null

Explicit null clears it. null leaves the member ABSENT; JsonNull::Null is an explicit JSON null, which is not the same thing (§27.4 rule 5). (optional)

$groupMappings : array<int, GroupMapping>|null = null

Replaces the whole table when present. (optional)

$groupMemberAttribute : string|null = null

See [SetDirectoryConfig::group_member_attribute]. (optional)

$groupNestingDepth : int|null = null

See [SetDirectoryConfig::group_nesting_depth]. (optional)

$jitProvisioning : bool|null = null

See [SetDirectoryConfig::jit_provisioning]. (optional)

$kind : DirectoryKind|null = null

the server's kind field (optional)

$startTls : bool|null = null

See [SetDirectoryConfig::start_tls]. (optional)

$syncIntervalSecs : int|null = null

See [SetDirectoryConfig::sync_interval_secs]. (optional)

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

Replaces the whole list when present. (optional)

$url : string|null = null

See [SetDirectoryConfig::url]. (optional)

$userAttributeMap : UserAttributeMap|null = null

the server's user_attribute_map field (optional)

$userFilter : string|null = null

See [SetDirectoryConfig::user_filter]. (optional)

fromArray()

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