AXIAM PHP SDK

SamlServiceProvider
in package
implements JsonSerializable

FinalYes

A registered service provider, as stored.

Table of Contents

Interfaces

JsonSerializable

Properties

$acsUrls  : array<string|int, mixed>
$allowedGroups  : array<string|int, mixed>
$allowIdpInitiated  : bool
$attributeMappings  : array<string|int, mixed>
$createdAt  : string
$displayName  : string
$enabled  : bool
$encryptAssertions  : bool
$entityId  : string
$id  : string
$nameIdFormat  : NameIdFormat
$signResponses  : bool
$sloBinding  : SamlBinding|null
$sloUrl  : string|null
$spEncryptionCertPem  : string|null
$spSigningCertPem  : string|null
$tenantId  : string
$updatedAt  : string
$wantAuthnRequestsSigned  : bool

Methods

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

public __construct(array<int, AcsEndpoint> $acsUrls, bool $allowIdpInitiated, array<int, string> $allowedGroups, array<int, AttributeMapping> $attributeMappings, string $createdAt, string $displayName, bool $enabled, bool $encryptAssertions, string $entityId, string $id, NameIdFormat $nameIdFormat, bool $signResponses, string $tenantId, string $updatedAt, bool $wantAuthnRequestsSigned[, SamlBinding|null $sloBinding = null ][, string|null $sloUrl = null ][, string|null $spEncryptionCertPem = null ][, string|null $spSigningCertPem = null ]) : mixed
Parameters
$acsUrls : array<int, AcsEndpoint>

See [SamlServiceProviderInput::acs_urls].

$allowIdpInitiated : bool

See [SamlServiceProviderInput::allow_idp_initiated].

$allowedGroups : array<int, string>

See [SamlServiceProviderInput::allowed_groups].

$attributeMappings : array<int, AttributeMapping>

See [SamlServiceProviderInput::attribute_mappings].

$createdAt : string

When the SP was registered.

$displayName : string

See [SamlServiceProviderInput::display_name].

$enabled : bool

See [SamlServiceProviderInput::enabled].

$encryptAssertions : bool

See [SamlServiceProviderInput::encrypt_assertions].

$entityId : string

See [SamlServiceProviderInput::entity_id].

$id : string

Record id.

$nameIdFormat : NameIdFormat

See [SamlServiceProviderInput::name_id_format].

$signResponses : bool

See [SamlServiceProviderInput::sign_responses].

$tenantId : string

The owning tenant.

$updatedAt : string

When it was last replaced.

$wantAuthnRequestsSigned : bool

See [SamlServiceProviderInput::want_authn_requests_signed].

$sloBinding : SamlBinding|null = null

the server's slo_binding field (optional)

$sloUrl : string|null = null

See [SamlServiceProviderInput::slo_url]. (optional)

$spEncryptionCertPem : string|null = null

See [SamlServiceProviderInput::sp_encryption_cert_pem]. (optional)

$spSigningCertPem : string|null = null

See [SamlServiceProviderInput::sp_signing_cert_pem]. (optional)

fromArray()

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