AXIAM PHP SDK

UpdateFederationConfigRequest
in package
implements JsonSerializable

FinalYes

The `UpdateFederationConfigRequest` schema from the server's OpenAPI document.

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

$allowedAlgorithms  : array<string|int, mixed>|null
$allowedIssuerTenants  : array<string|int, mixed>|null
$allowSha1Signatures  : bool|null
$allowTenantInheritance  : bool|null
$appleKeyId  : string|JsonNull|null
$appleTeamId  : string|JsonNull|null
$attributeMap  : mixed
$authorizationEndpoint  : string|JsonNull|null
$buttonIcon  : string|JsonNull|null
$clientId  : string|null
$clientSecret  : Sensitive|null
$enabled  : bool|null
$idpMetadataSigningCertPem  : string|JsonNull|null
$idpSigningCertPem  : string|JsonNull|null
$metadataUrl  : string|JsonNull|null
$provider  : string|null
$providerSlug  : string|JsonNull|null
$requirePkce  : bool|null
$scopes  : array<string|int, mixed>|null
$tokenEndpoint  : string|JsonNull|null
$tokenExchange  : TokenExchangeTrustRequest|null
$userinfoEndpoint  : string|JsonNull|null

Methods

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

Methods

__construct()

Constructs a UpdateFederationConfigRequest.

public __construct([bool|null $allowSha1Signatures = null ][, bool|null $allowTenantInheritance = null ][, array<int, string>|null $allowedAlgorithms = null ][, array<int, string>|null $allowedIssuerTenants = null ][, string|JsonNull|null $appleKeyId = null ][, string|JsonNull|null $appleTeamId = null ][, mixed $attributeMap = null ][, string|JsonNull|null $authorizationEndpoint = null ][, string|JsonNull|null $buttonIcon = null ][, string|null $clientId = null ][, Sensitive|null $clientSecret = null ][, bool|null $enabled = null ][, string|JsonNull|null $idpMetadataSigningCertPem = null ][, string|JsonNull|null $idpSigningCertPem = null ][, string|JsonNull|null $metadataUrl = null ][, string|null $provider = null ][, string|JsonNull|null $providerSlug = null ][, bool|null $requirePkce = null ][, array<int, string>|null $scopes = null ][, string|JsonNull|null $tokenEndpoint = null ][, TokenExchangeTrustRequest|null $tokenExchange = null ][, string|JsonNull|null $userinfoEndpoint = null ]) : mixed
Parameters
$allowSha1Signatures : bool|null = null

SAML only: accept IdP responses signed with SHA-1. Refused on a non-SAML config; turning it on is audited (federation.sha1_signatures_allowed). (optional)

$allowTenantInheritance : bool|null = null

Whether tenants may inherit this organization-level provider. (optional)

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

Accepted signature algorithms (CQ-B40/REQ-14 AC-5). (optional)

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

Accepted external IdP tenants for a templated issuer. Replaced wholesale. (optional)

$appleKeyId : string|JsonNull|null = null

Apple Key ID. 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)

$appleTeamId : string|JsonNull|null = null

Apple Team ID. 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)

$attributeMap : mixed = null

the server's attribute_map field (optional)

$authorizationEndpoint : string|JsonNull|null = null

OAuth2-variant authorization endpoint. 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)

$buttonIcon : string|JsonNull|null = null

Sign-in-button icon for a generic provider. 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)

$clientId : string|null = null

the server's client_id field (optional)

$clientSecret : Sensitive|null = null

the server's client_secret field — a one-time secret (§27.5) (optional)

$enabled : bool|null = null

the server's enabled field (optional)

$idpMetadataSigningCertPem : string|JsonNull|null = null

SAML only: the IdP metadata signing certificate (#530). Explicit null clears it; omitted leaves it. Clearing it is audited (federation.metadata_signing_cert_cleared), and so is replacing it with a different certificate (federation.metadata_signing_cert_changed). null leaves the member ABSENT; JsonNull::Null is an explicit JSON null, which is not the same thing (§27.4 rule 5). (optional)

$idpSigningCertPem : string|JsonNull|null = null

PEM-encoded X.509 certificate for verifying SAML assertions (CQ-B40/REQ-14 AC-5). Explicit null clears the stored cert; omitted leaves it. null leaves the member ABSENT; JsonNull::Null is an explicit JSON null, which is not the same thing (§27.4 rule 5). (optional)

$metadataUrl : string|JsonNull|null = null

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

$provider : string|null = null

the server's provider field (optional)

$providerSlug : string|JsonNull|null = null

Operator-chosen identifier for a generic_* kind. 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)

$requirePkce : bool|null = null

Send PKCE on the authorization request. (optional)

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

Scopes to request. Replaced wholesale; empty restores the per-kind default. (optional)

$tokenEndpoint : string|JsonNull|null = null

OAuth2-variant token endpoint. 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)

$tokenExchange : TokenExchangeTrustRequest|null = null

the server's token_exchange field (optional)

$userinfoEndpoint : string|JsonNull|null = null

OAuth2-variant userinfo endpoint. 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)

fromArray()

Rebuilds a UpdateFederationConfigRequest 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>
On this page

Search results