AXIAM PHP SDK

ScimTargetResponse
in package
implements JsonSerializable

FinalYes

A registered SCIM target, as the management API returns it. **The credential is never returned**, and there is no member that says anything about it.

Table of Contents

Interfaces

JsonSerializable

Properties

$auth  : ScimTargetAuthVariant
$baseUrl  : string
$createdAt  : string
$deprovision  : DeprovisionPolicy
$enabled  : bool
$id  : string
$name  : string
$pushGroups  : bool
$scope  : ScimTargetScopeVariant
$state  : ScimTargetDeliveryState|null
$tenantId  : string
$updatedAt  : string
$userNameFrom  : UserNameSource

Methods

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

public __construct(ScimTargetAuthVariant $auth, string $baseUrl, string $createdAt, DeprovisionPolicy $deprovision, bool $enabled, string $id, string $name, bool $pushGroups, ScimTargetScopeVariant $scope, string $tenantId, string $updatedAt, UserNameSource $userNameFrom[, ScimTargetDeliveryState|null $state = null ]) : mixed
Parameters
$auth : ScimTargetAuthVariant

How AXIAM authenticates to it (no credential).

$baseUrl : string

The downstream's SCIM service root.

$createdAt : string

When the target was registered.

$deprovision : DeprovisionPolicy

What happens downstream to a user who leaves scope or is no longer active (erasure always deletes).

$enabled : bool

Whether AXIAM pushes to it.

$id : string

The target id.

$name : string

The name.

$pushGroups : bool

Whether groups are pushed too.

$scope : ScimTargetScopeVariant

Which users it provisions.

$tenantId : string

The owning tenant.

$updatedAt : string

When it was last written: the version an update is conditional on.

$userNameFrom : UserNameSource

Which attribute becomes userName.

$state : ScimTargetDeliveryState|null = null

the server's state field (optional)

fromArray()

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