AXIAM PHP SDK

ScimTargetInput
in package
implements JsonSerializable

FinalYes

`create` and `update` (a **replacement**) body.

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. Left unset, the write-only secret (credential) is not reset but kept -- see the operation's documentation for when a write must carry it.

Table of Contents

Interfaces

JsonSerializable

Properties

$auth  : ScimTargetAuthVariant
$baseUrl  : string
$credential  : Sensitive|null
$deprovision  : DeprovisionPolicy|null
$enabled  : bool|null
$expectedUpdatedAt  : string|null
$name  : string
$pushGroups  : bool|null
$scope  : ScimTargetScopeVariant
$userNameFrom  : UserNameSource|null

Methods

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

$expectedUpdatedAt read-only

public string|null $expectedUpdatedAt = null

Methods

__construct()

Constructs a ScimTargetInput.

public __construct(ScimTargetAuthVariant $auth, string $baseUrl, string $name, ScimTargetScopeVariant $scope[, Sensitive|null $credential = null ][, DeprovisionPolicy|null $deprovision = null ][, bool|null $enabled = null ][, string|null $expectedUpdatedAt = null ][, bool|null $pushGroups = null ][, UserNameSource|null $userNameFrom = null ]) : mixed
Parameters
$auth : ScimTargetAuthVariant

bearer, or oauth2_client_credentials with token_url (the same URL policy), client_id (1–256 bytes) and an optional scope.

$baseUrl : string

The downstream's SCIM service root: an https URL under the outbound address policy (no credentials or fragment, at most 2 048 bytes, no non-public address, no local name).

$name : string

1–128 bytes.

$scope : ScimTargetScopeVariant

all_users, or groups with 1–100 group_ids of this tenant: users who are direct members of any listed group.

$credential : Sensitive|null = null

Write-only. The bearer token or the OAuth2 client secret, 1–4 096 bytes. Required on create. On update, absent keeps the stored one — except that moving it to another URL (base_url of a bearer target, token_url or base_url of a client-credentials one) or switching auth.type requires it again. (optional)

$deprovision : DeprovisionPolicy|null = null

deactivate (default: PATCH active=false) or delete. (optional)

$enabled : bool|null = null

true by default. A disabled target receives nothing. (optional)

$expectedUpdatedAt : string|null = null

The updated_at of the target as the client read it (P23W5-09, T-416). Update only; create ignores it. When present, the replacement lands only if the target still has that version, else 409 (reload and retry): two administrators who opened the form at the same version cannot silently overwrite each other. When absent the replacement is conditional on the version the server reads during the request — last-writer-wins between administrators, as before. (optional)

$pushGroups : bool|null = null

Push groups too (every group for all_users, the listed ones for groups). false by default. (optional)

$userNameFrom : UserNameSource|null = null

username (default) or email. (optional)

fromArray()

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