AXIAM PHP SDK

SamlIdpInfo
in package
implements JsonSerializable

FinalYes

The tenant's SAML IdP, as the administrator needs to see it before and while switching it on: what an SP will be given, and whether it answers yet.

Table of Contents

Interfaces

JsonSerializable

Properties

$activeCredentialId  : string|JsonNull|null
$entityId  : string
$metadataServed  : bool
$metadataUrl  : string
$nextCredentialId  : string|JsonNull|null
$samlAvailable  : bool
$samlIdpEnabled  : bool
$sloUrl  : string
$ssoUrl  : string
$tenantId  : string

Methods

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

$metadataServed read-only

public bool $metadataServed

$samlIdpEnabled read-only

public bool $samlIdpEnabled

Methods

__construct()

Constructs a SamlIdpInfo.

public __construct(string $entityId, bool $metadataServed, string $metadataUrl, bool $samlAvailable, bool $samlIdpEnabled, string $sloUrl, string $ssoUrl, string $tenantId[, string|JsonNull|null $activeCredentialId = null ][, string|JsonNull|null $nextCredentialId = null ]) : mixed
Parameters
$entityId : string

The IdP's entity id (the metadata URL itself).

$metadataServed : bool

Whether metadata_url answers now: SAML is available, enabled for the tenant, and an active or next credential exists (D-40).

$metadataUrl : string

Where the IdP metadata is served.

$samlAvailable : bool

Whether this server build serves SAML at all (it was built with the saml feature).

$samlIdpEnabled : bool

The tenant's effective saml_idp_enabled setting (D-20). Written through the settings operations, not here.

$sloUrl : string

The single-logout endpoint.

$ssoUrl : string

The single-sign-on endpoint.

$tenantId : string

The tenant.

$activeCredentialId : string|JsonNull|null = null

The active credential, or null. null leaves the member ABSENT; JsonNull::Null is an explicit JSON null, which is not the same thing (§27.4 rule 5). (optional)

$nextCredentialId : string|JsonNull|null = null

The next credential, or null. null leaves the member ABSENT; JsonNull::Null is an explicit JSON null, which is not the same thing (§27.4 rule 5). (optional)

fromArray()

Rebuilds a SamlIdpInfo 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).

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