AXIAM PHP SDK

FederationConfigResponse
in package
implements JsonSerializable

FinalYes

Federation config response -- omits client_secret.

Table of Contents

Interfaces

JsonSerializable

Properties

$allowedAlgorithms  : array<string|int, mixed>
$allowedIssuerTenants  : array<string|int, mixed>
$allowTenantInheritance  : bool
$appleKeyId  : string|null
$appleTeamId  : string|null
$attributeMap  : mixed
$authorizationEndpoint  : string|null
$buttonIcon  : string|null
$clientId  : string
$createdAt  : string
$effectiveScopes  : array<string|int, mixed>
$enabled  : bool
$hasBundledMark  : bool
$id  : string
$metadataUrl  : string|null
$mintsClientSecret  : bool
$pkceRequired  : bool
$protocol  : string
$provider  : string
$providerKind  : string
$providerSlug  : string|null
$scopes  : array<string|int, mixed>
$tenantId  : string
$tokenEndpoint  : string|null
$tokenExchange  : TokenExchangeTrustResponse
$updatedAt  : string
$userinfoEndpoint  : string|null

Methods

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

public __construct(bool $allowTenantInheritance, array<int, string> $allowedAlgorithms, array<int, string> $allowedIssuerTenants, mixed $attributeMap, string $clientId, string $createdAt, array<int, string> $effectiveScopes, bool $enabled, bool $hasBundledMark, string $id, bool $mintsClientSecret, bool $pkceRequired, string $protocol, string $provider, string $providerKind, array<int, string> $scopes, string $tenantId, TokenExchangeTrustResponse $tokenExchange, string $updatedAt[, string|null $appleKeyId = null ][, string|null $appleTeamId = null ][, string|null $authorizationEndpoint = null ][, string|null $buttonIcon = null ][, string|null $metadataUrl = null ][, string|null $providerSlug = null ][, string|null $tokenEndpoint = null ][, string|null $userinfoEndpoint = null ]) : mixed
Parameters
$allowTenantInheritance : bool

Whether tenants of this organization may inherit this provider.

$allowedAlgorithms : array<int, string>

Accepted signing algorithms. Returned for OIDC and SAML; meaningless, and therefore empty, for the OAuth2 variant.

$allowedIssuerTenants : array<int, string>

Accepted external IdP tenants for a templated issuer.

$attributeMap : mixed

the server's attribute_map field

$clientId : string

the server's client_id field

$createdAt : string

the server's created_at field

$effectiveScopes : array<int, string>

The per-kind default that an empty scopes resolves to. Returned so the admin UI can show what will actually be requested without duplicating the table.

$enabled : bool

the server's enabled field

$hasBundledMark : bool

Whether AXIAM ships this provider's own mark. When true the button uses it and button_icon is refused; when false the button reads "Sign in with " and may carry a custom icon.

$id : string

the server's id field

$mintsClientSecret : bool

Whether AXIAM mints this provider's client secret itself, per exchange, rather than sending a stored one. True only for an Apple config with both identifiers set.

$pkceRequired : bool

Whether PKCE is sent on the authorization request. Always true for the OAuth2 variant regardless of the stored flag.

$protocol : string

the server's protocol field

$provider : string

the server's provider field

$providerKind : string

Which provider this is. Derived from protocol for a config written before the field existed.

$scopes : array<int, string>

Scopes as stored. Empty means "use the per-kind default"; see effective_scopes.

$tenantId : string

the server's tenant_id field

$tokenExchange : TokenExchangeTrustResponse

X4 external token-exchange trust.

$updatedAt : string

the server's updated_at field

$appleKeyId : string|null = null

Apple Key ID. (optional)

$appleTeamId : string|null = null

Apple Team ID. Not secret — the .p8 key is, and it is never returned. (optional)

$authorizationEndpoint : string|null = null

OAuth2-variant authorization endpoint. (optional)

$buttonIcon : string|null = null

Custom sign-in-button icon, when one is set. (optional)

$metadataUrl : string|null = null

the server's metadata_url field (optional)

$providerSlug : string|null = null

Operator-chosen identifier for a generic_* kind. (optional)

$tokenEndpoint : string|null = null

OAuth2-variant token endpoint. (optional)

$userinfoEndpoint : string|null = null

OAuth2-variant userinfo endpoint. (optional)

fromArray()

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